mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/MultimediaViewer
synced 2024-09-29 21:28:12 +00:00
284a936aff
Cache API responses, both on Varnish and in the user's browser. The imageinfo request is not cached, since that would make it very hard to test metadata template edits. Everything else is cached for one day. Change-Id: I9149cf40d4448a424073eefd1eb442c70c977687 Mingle: https://wikimedia.mingle.thoughtworks.com/projects/multimedia/cards/435
79 lines
2.8 KiB
JavaScript
79 lines
2.8 KiB
JavaScript
/*
|
|
* 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 user information (currently just the gender).
|
|
* See https://www.mediawiki.org/wiki/API:Users
|
|
* @class mw.mmv.provider.UserInfo
|
|
* @extends mw.mmv.provider.Api
|
|
* @constructor
|
|
* @param {mw.Api} api
|
|
* @param {Object} [options]
|
|
* @cfg {number} [maxage] cache expiration time, in seconds
|
|
* Will be used for both client-side cache (maxage) and reverse proxies (s-maxage)
|
|
*/
|
|
function UserInfo( api, options ) {
|
|
mw.mmv.provider.Api.call( this, api, options );
|
|
}
|
|
oo.inheritClass( UserInfo, mw.mmv.provider.Api );
|
|
|
|
/**
|
|
* Runs an API GET request to get the user info.
|
|
* @param {string} username
|
|
* @param {mw.mmv.model.Repo} repoInfo
|
|
* @return {jQuery.Promise.<mw.mmv.model.User>} user
|
|
*/
|
|
UserInfo.prototype.get = function( username, repoInfo ) {
|
|
var provider = this,
|
|
ajaxOptions = {},
|
|
cacheKey = username;
|
|
|
|
// For local/shared db images the user should be visible via a local API request,
|
|
// maybe. (In practice we have Wikimedia users who haven't completed the SUL
|
|
// merge process yet, and other sites might even use a shared DB for images
|
|
// without CentralAuth. Too bad for them.)
|
|
// For InstantCommons images we need to get user data directly from the repo's API.
|
|
if ( repoInfo.apiUrl ) {
|
|
ajaxOptions.url = repoInfo.apiUrl;
|
|
ajaxOptions.dataType = 'jsonp';
|
|
cacheKey = cacheKey + '|' + repoInfo.apiUrl; // local and remote user names could conflict
|
|
}
|
|
|
|
return this.getCachedPromise( cacheKey, function () {
|
|
return provider.apiGetWithMaxAge( {
|
|
action: 'query',
|
|
list: 'users',
|
|
ususers: username,
|
|
usprop: 'gender'
|
|
}, ajaxOptions ).then( function( data ) {
|
|
return provider.getQueryField( 'users', data );
|
|
} ).then( function( users ) {
|
|
if ( users[0] && users[0].name && users[0].gender ) {
|
|
return new mw.mmv.model.User( users[0].name, users[0].gender );
|
|
} else {
|
|
mw.log( 'user info not found for ' + username + ' at ' + repoInfo.name);
|
|
return new mw.mmv.model.User( username, mw.mmv.model.User.Gender.UNKNOWN );
|
|
}
|
|
} );
|
|
} );
|
|
};
|
|
|
|
mw.mmv.provider.UserInfo = UserInfo;
|
|
}( mediaWiki, OO ) );
|