1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/*
* 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, $ ) {
/**
* Gets file information.
*
* See https://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii
*
* @class mw.mmv.provider.ImageInfo
* @extends mw.mmv.provider.Api
* @constructor
* @param {mw.Api} api
* @param {Object} [options]
* @cfg {string} [language=null] image metadata language
* @cfg {number} [maxage] cache expiration time, in seconds
* Will be used for both client-side cache (maxage) and reverse proxies (s-maxage)
*/
function ImageInfo( api, options ) {
options = $.extend( {
language: null
}, options );
mw.mmv.provider.Api.call( this, api, options );
}
oo.inheritClass( ImageInfo, mw.mmv.provider.Api );
/**
* List of imageinfo API properties which are needed to construct an Image model.
*
* @property {string}
*/
ImageInfo.prototype.iiprop = [
'timestamp',
'url',
'size',
'mime',
'mediatype',
'extmetadata'
].join( '|' );
/**
* List of imageinfo extmetadata fields which are needed to construct an Image model.
*
* @property {string}
*/
ImageInfo.prototype.iiextmetadatafilter = [
'DateTime',
'DateTimeOriginal',
'ObjectName',
'ImageDescription',
'License',
'LicenseShortName',
'UsageTerms',
'LicenseUrl',
'Credit',
'Artist',
'AuthorCount',
'GPSLatitude',
'GPSLongitude',
'Permission',
'Attribution',
'AttributionRequired',
'NonFree',
'Restrictions',
'DeletionReason'
].join( '|' );
/**
* Runs an API GET request to get the image info.
*
* @param {mw.Title} file
* @return {jQuery.Promise} a promise which resolves to an mw.mmv.model.Image object.
*/
ImageInfo.prototype.get = function ( file ) {
var provider = this;
return this.getCachedPromise( file.getPrefixedDb(), function () {
return provider.apiGetWithMaxAge( {
action: 'query',
prop: 'imageinfo',
titles: file.getPrefixedDb(),
iiprop: provider.iiprop,
iiextmetadatafilter: provider.iiextmetadatafilter,
iiextmetadatalanguage: provider.options.language,
uselang: 'content'
} ).then( function ( data ) {
return provider.getQueryPage( file, data );
} ).then( function ( page ) {
if ( page.imageinfo && page.imageinfo.length ) {
return mw.mmv.model.Image.newFromImageInfo( file, page );
} else if ( page.missing === '' && page.imagerepository === '' ) {
return $.Deferred().reject( 'file does not exist: ' + file.getPrefixedDb() );
} else {
return $.Deferred().reject( 'unknown error' );
}
} );
} );
};
mw.mmv.provider.ImageInfo = ImageInfo;
}( mediaWiki, OO, jQuery ) );
|
