mediawiki-extensions-Multim.../resources/mmv/provider/mmv.provider.FileRepoInfo.js
Gergő Tisza 284a936aff Cache API responses
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
2014-04-22 10:56:52 +02:00

61 lines
2 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 file repo information.
* @class mw.mmv.provider.FileRepoInfo
* @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 FileRepoInfo( api, options ) {
mw.mmv.provider.Api.call( this, api, options );
}
oo.inheritClass( FileRepoInfo, mw.mmv.provider.Api );
/**
* Runs an API GET request to get the repo info.
* @return {jQuery.Promise.<Object.<string, mw.mmv.model.Repo>>} a promise which resolves to
* a hash of mw.mmv.model.Repo objects, indexed by repo names.
*/
FileRepoInfo.prototype.get = function() {
var provider = this;
return this.getCachedPromise( '*', function () {
return provider.apiGetWithMaxAge( {
action: 'query',
meta: 'filerepoinfo'
} ).then( function( data ) {
return provider.getQueryField( 'repos', data );
} ).then( function( reposArray ) {
var reposHash = {};
$.each( reposArray, function ( i, repo ) {
reposHash[repo.name] = mw.mmv.model.Repo.newFromRepoInfo( repo );
} );
return reposHash;
} );
} );
};
mw.mmv.provider.FileRepoInfo = FileRepoInfo;
}( mediaWiki, OO, jQuery ) );