mediawiki-extensions-Multim.../resources/mmv/provider/mmv.provider.GlobalUsage.js
Gergő Tisza e0edec21b2 Move providers into their own subdirectory
Also refactor MultimediaViewer.php a bit to get rid of all the globals.

Mingle: https://wikimedia.mingle.thoughtworks.com/projects/multimedia/cards/123
Change-Id: Ieca4263ecc7652dc6bc36db63b99d3813c4653e4
2014-02-01 03:49:30 +00:00

106 lines
3.6 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, $ ) {
/**
* @class mw.mmv.provider.GlobalUsage
* Gets file usage information on all wikis but the local one.
* This needs the [GlobalUsage extension](https://www.mediawiki.org/wiki/Extension:GlobalUsage)
* to be installed.
* @extends mw.mmv.provider.Api
* @inheritdoc
* @param {mw.Api} api
* @param {Object} [options]
* @param {number[]} [options.namespaces] list of namespace ids
* @param {number} [options.apiLimit] number of entries to get from the API. If there are
* more pages than this, we won't have an accurate count.
* (Also, influences query performance.)
* @param {boolean} [options.doNotUseApi] If true, always returns an empty result immediately,
* without doing an actual API call. Used when the GlobalUsage extension (and thus the
* API) is not available.
* @param {number} [options.dataLimit] number of entries to actually put into the model.
*/
function GlobalUsage( api, options ) {
options = $.extend( {
doNotUseApi: false,
apiLimit: 100,
dataLimit: 10
}, options );
mw.mmv.provider.Api.call( this, api, options );
}
oo.inheritClass( GlobalUsage, mw.mmv.provider.Api );
/**
* @method
* Fetches the global usage data from the API.
* @param {mw.Title} file
* @return {jQuery.Promise}
*/
GlobalUsage.prototype.get = function( file ) {
var provider = this,
cacheKey = file.getPrefixedDb(),
fileUsage;
if ( this.options.doNotUseApi ) {
fileUsage = new mw.mmv.model.FileUsage( file, mw.mmv.model.FileUsage.Scope.GLOBAL,
[], 0, false );
fileUsage.fake = true;
return $.Deferred().resolve( fileUsage );
}
if ( !this.cache[cacheKey] ) {
this.cache[cacheKey] = this.api.get( {
action: 'query',
prop: 'globalusage',
titles: file.getPrefixedDb(),
guprop: ['url', 'namespace'],
gufilterlocal: 1,
gulimit: this.options.apiLimit,
format: 'json'
} ).then( function( data ) {
var pages;
if ( data && data.query && data.query.pages ) {
// pages is an associative array indexed by pageid, turn it into proper array
pages = $.map( data.query.pages, function ( v ) { return v; } );
// the API returns a result for non-existent files as well so pages[0] will always exist
pages = $.map( pages[0].globalusage || {}, function( item ) {
return {
wiki: item.wiki,
page: new mw.Title( item.title, item.ns )
};
} );
return new mw.mmv.model.FileUsage(
file,
mw.mmv.model.FileUsage.Scope.GLOBAL,
pages.slice( 0, provider.options.dataLimit ),
pages.length,
!!( data['query-continue'] && data['query-continue'].globalusage )
);
} else {
return $.Deferred().reject( provider.getErrorMessage( data ) );
}
} );
}
return this.cache[cacheKey];
};
mw.mmv.provider.GlobalUsage = GlobalUsage;
}( mediaWiki, OO, jQuery ) );