mediawiki-extensions-Multim.../resources/mmv/provider/mmv.provider.ImageUsage.js
Gergő Tisza 7afbc5ce92 Use provider XHR information in performance metrics + several fixes
* more robust method of obtaining URL
* decouple performance logging from providers (mostly)
* ignore fake XHR object which jQuery returns for JSONP requests
* guard for CORS requests - apparently Chrome refuses to return
  certain information even with an Allow-Origin: * response header.
* Resource Timing is limited to 150 results, which causes fake
  misses in debug mode. There is an API to increase the limit
  but it is not implemented in Chrome. I am calling it nevertheless,
  maybe IE understands it (it is present in the MSDN docs at least).

This seems to work for AJAX, CORS, JSONP, image AJAX; CORS requests
return 0 for a lot of values, per spec a Timing-Allow-Origin: *
header might help that.

Change-Id: I8353858022f51a7e70774e65513d0fa2554a5064
2014-02-19 00:38:27 +00:00

87 lines
2.7 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.ImageUsage
* Gets file usage information on the local wiki.
* @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 {number} [options.dataLimit] number of entries to actually put into the model.
*/
function ImageUsage( api, options ) {
options = $.extend( {
namespaces: [0, 100], // article, portal
apiLimit: 100,
dataLimit: 10
}, options );
mw.mmv.provider.Api.call( this, api, options );
}
oo.inheritClass( ImageUsage, mw.mmv.provider.Api );
/**
* @method
* Runs an API GET request to get the image usage.
* @param {mw.Title} file
* @return {jQuery.Promise}
*/
ImageUsage.prototype.get = function( file ) {
var provider = this,
cacheKey = file.getPrefixedDb();
if ( !this.cache[cacheKey] ) {
this.cache[cacheKey] = this.api.get( {
action: 'query',
list: 'imageusage',
iutitle: file.getPrefixedDb(),
iunamespace: this.options.namespaces,
iulimit: this.options.apiLimit,
format: 'json'
} ).then( function( data ) {
return provider.getQueryField( 'imageusage', data );
} ).then( function( imageusage, data ) {
var pages;
pages = $.map( imageusage, function( item ) {
return {
wiki: null,
page: new mw.Title( item.title, item.ns )
};
} );
return new mw.mmv.model.FileUsage(
file,
mw.mmv.model.FileUsage.Scope.LOCAL,
pages.slice( 0, provider.options.dataLimit ),
pages.length,
!!( data['query-continue'] && data['query-continue'].imageusage )
);
} );
}
return this.cache[cacheKey];
};
mw.mmv.provider.ImageUsage = ImageUsage;
}( mediaWiki, OO, jQuery ) );