1 files changed, 224 insertions, 0 deletions
diff --git a/www/wiki/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js b/www/wiki/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js
new file mode 100644
index 00000000..3bc1d51b
--- /dev/null
+++ b/www/wiki/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js
@@ -0,0 +1,224 @@
+/*!
+ * MediaWiki Widgets - APIResultsQueue class.
+ *
+ * @copyright 2011-2016 VisualEditor Team and others; see http://ve.mit-license.org
+ */
+( function ( $, mw ) {
+
+	/**
+	 * API Results Queue object.
+	 *
+	 * @class
+	 * @mixins OO.EventEmitter
+	 *
+	 * @constructor
+	 * @param {Object} [config] Configuration options
+	 * @cfg {number} limit The default number of results to fetch
+	 * @cfg {number} threshold The default number of extra results
+	 *  that the queue should always strive to have on top of the
+	 *  individual requests for items.
+	 */
+	mw.widgets.APIResultsQueue = function MwWidgetsAPIResultsQueue( config ) {
+		config = config || {};
+
+		this.fileRepoPromise = null;
+		this.providers = [];
+		this.providerPromises = [];
+		this.queue = [];
+
+		this.params = {};
+
+		this.limit = config.limit || 20;
+		this.setThreshold( config.threshold || 10 );
+
+		// Mixin constructors
+		OO.EventEmitter.call( this );
+	};
+
+	/* Setup */
+	OO.mixinClass( mw.widgets.APIResultsQueue, OO.EventEmitter );
+
+	/* Methods */
+
+	/**
+	 * Set up the queue and its resources.
+	 * This should be overridden if there are any setup steps to perform.
+	 *
+	 * @return {jQuery.Promise} Promise that resolves when the resources
+	 *  are set up. Note: The promise must have an .abort() functionality.
+	 */
+	mw.widgets.APIResultsQueue.prototype.setup = function () {
+		return $.Deferred().resolve().promise( { abort: $.noop } );
+	};
+
+	/**
+	 * Get items from the queue
+	 *
+	 * @param {number} [howMany] How many items to retrieve. Defaults to the
+	 *  default limit supplied on initialization.
+	 * @return {jQuery.Promise} Promise that resolves into an array of items.
+	 */
+	mw.widgets.APIResultsQueue.prototype.get = function ( howMany ) {
+		var fetchingPromise = null,
+			me = this;
+
+		howMany = howMany || this.limit;
+
+		// Check if the queue has enough items
+		if ( this.queue.length < howMany + this.threshold ) {
+			// Call for more results
+			fetchingPromise = this.queryProviders( howMany + this.threshold )
+				.then( function ( items ) {
+					// Add to the queue
+					me.queue = me.queue.concat.apply( me.queue, items );
+				} );
+		}
+
+		return $.when( fetchingPromise )
+			.then( function () {
+				return me.queue.splice( 0, howMany );
+			} );
+
+	};
+
+	/**
+	 * Get results from all providers
+	 *
+	 * @param {number} [howMany] How many items to retrieve. Defaults to the
+	 *  default limit supplied on initialization.
+	 * @return {jQuery.Promise} Promise that is resolved into an array
+	 *  of fetched items. Note: The promise must have an .abort() functionality.
+	 */
+	mw.widgets.APIResultsQueue.prototype.queryProviders = function ( howMany ) {
+		var i, len,
+			queue = this;
+
+		// Make sure there are resources set up
+		return this.setup()
+			.then( function () {
+				// Abort previous requests
+				for ( i = 0, len = queue.providerPromises.length; i < len; i++ ) {
+					queue.providerPromises[ i ].abort();
+				}
+				queue.providerPromises = [];
+				// Set up the query to all providers
+				for ( i = 0, len = queue.providers.length; i < len; i++ ) {
+					if ( !queue.providers[ i ].isDepleted() ) {
+						queue.providerPromises.push(
+							queue.providers[ i ].getResults( howMany )
+						);
+					}
+				}
+
+				return $.when.apply( $, queue.providerPromises )
+					.then( Array.prototype.concat.bind( [] ) );
+			} );
+	};
+
+	/**
+	 * Set the search query for all the providers.
+	 *
+	 * This also makes sure to abort any previous promises.
+	 *
+	 * @param {Object} params API search parameters
+	 */
+	mw.widgets.APIResultsQueue.prototype.setParams = function ( params ) {
+		var i, len;
+		if ( !OO.compare( params, this.params, true ) ) {
+			this.reset();
+			this.params = $.extend( this.params, params );
+			// Reset queue
+			this.queue = [];
+			// Reset promises
+			for ( i = 0, len = this.providerPromises.length; i < len; i++ ) {
+				this.providerPromises[ i ].abort();
+			}
+			// Change queries
+			for ( i = 0, len = this.providers.length; i < len; i++ ) {
+				this.providers[ i ].setUserParams( this.params );
+			}
+		}
+	};
+
+	/**
+	 * Reset the queue and all its providers
+	 */
+	mw.widgets.APIResultsQueue.prototype.reset = function () {
+		var i, len;
+		// Reset queue
+		this.queue = [];
+		// Reset promises
+		for ( i = 0, len = this.providerPromises.length; i < len; i++ ) {
+			this.providerPromises[ i ].abort();
+		}
+		// Change queries
+		for ( i = 0, len = this.providers.length; i < len; i++ ) {
+			this.providers[ i ].reset();
+		}
+	};
+
+	/**
+	 * Get the data parameters sent to the API
+	 *
+	 * @return {Object} params API search parameters
+	 */
+	mw.widgets.APIResultsQueue.prototype.getParams = function () {
+		return this.params;
+	};
+
+	/**
+	 * Set the providers
+	 *
+	 * @param {mw.widgets.APIResultsProvider[]} providers An array of providers
+	 */
+	mw.widgets.APIResultsQueue.prototype.setProviders = function ( providers ) {
+		this.providers = providers;
+	};
+
+	/**
+	 * Add a provider to the group
+	 *
+	 * @param {mw.widgets.APIResultsProvider} provider A provider object
+	 */
+	mw.widgets.APIResultsQueue.prototype.addProvider = function ( provider ) {
+		this.providers.push( provider );
+	};
+
+	/**
+	 * Set the providers
+	 *
+	 * @return {mw.widgets.APIResultsProvider[]} providers An array of providers
+	 */
+	mw.widgets.APIResultsQueue.prototype.getProviders = function () {
+		return this.providers;
+	};
+
+	/**
+	 * Get the queue size
+	 *
+	 * @return {number} Queue size
+	 */
+	mw.widgets.APIResultsQueue.prototype.getQueueSize = function () {
+		return this.queue.length;
+	};
+
+	/**
+	 * Set queue threshold
+	 *
+	 * @param {number} threshold Queue threshold, below which we will
+	 *  request more items
+	 */
+	mw.widgets.APIResultsQueue.prototype.setThreshold = function ( threshold ) {
+		this.threshold = threshold;
+	};
+
+	/**
+	 * Get queue threshold
+	 *
+	 * @return {number} threshold Queue threshold, below which we will
+	 *  request more items
+	 */
+	mw.widgets.APIResultsQueue.prototype.getThreshold = function () {
+		return this.threshold;
+	};
+}( jQuery, mediaWiki ) );