1 files changed, 414 insertions, 0 deletions
diff --git a/www/wiki/resources/src/mediawiki.widgets/mw.widgets.CategoryMultiselectWidget.js b/www/wiki/resources/src/mediawiki.widgets/mw.widgets.CategoryMultiselectWidget.js
new file mode 100644
index 00000000..354fcd94
--- /dev/null
+++ b/www/wiki/resources/src/mediawiki.widgets/mw.widgets.CategoryMultiselectWidget.js
@@ -0,0 +1,414 @@
+/*!
+ * MediaWiki Widgets - CategoryMultiselectWidget class.
+ *
+ * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
+ * @license The MIT License (MIT); see LICENSE.txt
+ */
+( function ( $, mw ) {
+	var hasOwn = Object.prototype.hasOwnProperty,
+		NS_CATEGORY = mw.config.get( 'wgNamespaceIds' ).category;
+
+	/**
+	 * Category selector widget. Displays an OO.ui.CapsuleMultiselectWidget
+	 * and autocompletes with available categories.
+	 *
+	 *     mw.loader.using( 'mediawiki.widgets.CategoryMultiselectWidget', function () {
+	 *       var selector = new mw.widgets.CategoryMultiselectWidget( {
+	 *         searchTypes: [
+	 *           mw.widgets.CategoryMultiselectWidget.SearchType.OpenSearch,
+	 *           mw.widgets.CategoryMultiselectWidget.SearchType.InternalSearch
+	 *         ]
+	 *       } );
+	 *
+	 *       $( 'body' ).append( selector.$element );
+	 *
+	 *       selector.setSearchTypes( [ mw.widgets.CategoryMultiselectWidget.SearchType.SubCategories ] );
+	 *     } );
+	 *
+	 * @class mw.widgets.CategoryMultiselectWidget
+	 * @uses mw.Api
+	 * @extends OO.ui.CapsuleMultiselectWidget
+	 * @mixins OO.ui.mixin.PendingElement
+	 *
+	 * @constructor
+	 * @param {Object} [config] Configuration options
+	 * @cfg {mw.Api} [api] Instance of mw.Api (or subclass thereof) to use for queries
+	 * @cfg {number} [limit=10] Maximum number of results to load
+	 * @cfg {mw.widgets.CategoryMultiselectWidget.SearchType[]} [searchTypes=[mw.widgets.CategoryMultiselectWidget.SearchType.OpenSearch]]
+	 *   Default search API to use when searching.
+	 */
+	mw.widgets.CategoryMultiselectWidget = function MWCategoryMultiselectWidget( config ) {
+		// Config initialization
+		config = $.extend( {
+			limit: 10,
+			searchTypes: [ mw.widgets.CategoryMultiselectWidget.SearchType.OpenSearch ]
+		}, config );
+		this.limit = config.limit;
+		this.searchTypes = config.searchTypes;
+		this.validateSearchTypes();
+
+		// Parent constructor
+		mw.widgets.CategoryMultiselectWidget.parent.call( this, $.extend( true, {}, config, {
+			menu: {
+				filterFromInput: false
+			},
+			placeholder: mw.msg( 'mw-widgets-categoryselector-add-category-placeholder' ),
+			// This allows the user to both select non-existent categories, and prevents the selector from
+			// being wiped from #onMenuItemsChange when we change the available options in the dropdown
+			allowArbitrary: true
+		} ) );
+
+		// Mixin constructors
+		OO.ui.mixin.PendingElement.call( this, $.extend( {}, config, { $pending: this.$handle } ) );
+
+		// Event handler to call the autocomplete methods
+		this.$input.on( 'change input cut paste', OO.ui.debounce( this.updateMenuItems.bind( this ), 100 ) );
+
+		// Initialize
+		this.api = config.api || new mw.Api();
+		this.searchCache = {};
+	};
+
+	/* Setup */
+
+	OO.inheritClass( mw.widgets.CategoryMultiselectWidget, OO.ui.CapsuleMultiselectWidget );
+	OO.mixinClass( mw.widgets.CategoryMultiselectWidget, OO.ui.mixin.PendingElement );
+
+	/* Methods */
+
+	/**
+	 * Gets new items based on the input by calling
+	 * {@link #getNewMenuItems getNewItems} and updates the menu
+	 * after removing duplicates based on the data value.
+	 *
+	 * @private
+	 * @method
+	 */
+	mw.widgets.CategoryMultiselectWidget.prototype.updateMenuItems = function () {
+		this.getMenu().clearItems();
+		this.getNewMenuItems( this.$input.val() ).then( function ( items ) {
+			var existingItems, filteredItems,
+				menu = this.getMenu();
+
+			// Never show the menu if the input lost focus in the meantime
+			if ( !this.$input.is( ':focus' ) ) {
+				return;
+			}
+
+			// Array of strings of the data of OO.ui.MenuOptionsWidgets
+			existingItems = menu.getItems().map( function ( item ) {
+				return item.data;
+			} );
+
+			// Remove if items' data already exists
+			filteredItems = items.filter( function ( item ) {
+				return existingItems.indexOf( item ) === -1;
+			} );
+
+			// Map to an array of OO.ui.MenuOptionWidgets
+			filteredItems = filteredItems.map( function ( item ) {
+				return new OO.ui.MenuOptionWidget( {
+					data: item,
+					label: item
+				} );
+			} );
+
+			menu.addItems( filteredItems ).toggle( true );
+		}.bind( this ) );
+	};
+
+	/**
+	 * @inheritdoc
+	 */
+	mw.widgets.CategoryMultiselectWidget.prototype.clearInput = function () {
+		mw.widgets.CategoryMultiselectWidget.parent.prototype.clearInput.call( this );
+		// Abort all pending requests, we won't need their results
+		this.api.abort();
+	};
+
+	/**
+	 * Searches for categories based on the input.
+	 *
+	 * @private
+	 * @method
+	 * @param {string} input The input used to prefix search categories
+	 * @return {jQuery.Promise} Resolves with an array of categories
+	 */
+	mw.widgets.CategoryMultiselectWidget.prototype.getNewMenuItems = function ( input ) {
+		var i,
+			promises = [],
+			deferred = $.Deferred();
+
+		if ( input.trim() === '' ) {
+			deferred.resolve( [] );
+			return deferred.promise();
+		}
+
+		// Abort all pending requests, we won't need their results
+		this.api.abort();
+		for ( i = 0; i < this.searchTypes.length; i++ ) {
+			promises.push( this.searchCategories( input, this.searchTypes[ i ] ) );
+		}
+
+		this.pushPending();
+
+		$.when.apply( $, promises ).done( function () {
+			var categoryNames,
+				allData = [],
+				dataSets = Array.prototype.slice.apply( arguments );
+
+			// Collect values from all results
+			allData = allData.concat.apply( allData, dataSets );
+
+			categoryNames = allData
+				// Remove duplicates
+				.filter( function ( value, index, self ) {
+					return self.indexOf( value ) === index;
+				} )
+				// Get Title objects
+				.map( function ( name ) {
+					return mw.Title.newFromText( name );
+				} )
+				// Keep only titles from 'Category' namespace
+				.filter( function ( title ) {
+					return title && title.getNamespaceId() === NS_CATEGORY;
+				} )
+				// Convert back to strings, strip 'Category:' prefix
+				.map( function ( title ) {
+					return title.getMainText();
+				} );
+
+			deferred.resolve( categoryNames );
+
+		} ).always( this.popPending.bind( this ) );
+
+		return deferred.promise();
+	};
+
+	/**
+	 * @inheritdoc
+	 */
+	mw.widgets.CategoryMultiselectWidget.prototype.createItemWidget = function ( data ) {
+		var title = mw.Title.makeTitle( NS_CATEGORY, data );
+		if ( !title ) {
+			return null;
+		}
+		return new mw.widgets.CategoryCapsuleItemWidget( {
+			apiUrl: this.api.apiUrl || undefined,
+			title: title
+		} );
+	};
+
+	/**
+	 * @inheritdoc
+	 */
+	mw.widgets.CategoryMultiselectWidget.prototype.findItemFromData = function ( data ) {
+		// This is a bit of a hack... We have to canonicalize the data in the same way that
+		// #createItemWidget and CategoryCapsuleItemWidget will do, otherwise we won't find duplicates.
+		var title = mw.Title.makeTitle( NS_CATEGORY, data );
+		if ( !title ) {
+			return null;
+		}
+		return OO.ui.mixin.GroupElement.prototype.findItemFromData.call( this, title.getMainText() );
+	};
+
+	/**
+	 * Validates the values in `this.searchType`.
+	 *
+	 * @private
+	 * @return {boolean}
+	 */
+	mw.widgets.CategoryMultiselectWidget.prototype.validateSearchTypes = function () {
+		var validSearchTypes = false,
+			searchTypeEnumCount = Object.keys( mw.widgets.CategoryMultiselectWidget.SearchType ).length;
+
+		// Check if all values are in the SearchType enum
+		validSearchTypes = this.searchTypes.every( function ( searchType ) {
+			return searchType > -1 && searchType < searchTypeEnumCount;
+		} );
+
+		if ( validSearchTypes === false ) {
+			throw new Error( 'Unknown searchType in searchTypes' );
+		}
+
+		// If the searchTypes has mw.widgets.CategoryMultiselectWidget.SearchType.SubCategories
+		// it can be the only search type.
+		if ( this.searchTypes.indexOf( mw.widgets.CategoryMultiselectWidget.SearchType.SubCategories ) > -1 &&
+			this.searchTypes.length > 1
+		) {
+			throw new Error( 'Can\'t have additional search types with mw.widgets.CategoryMultiselectWidget.SearchType.SubCategories' );
+		}
+
+		// If the searchTypes has mw.widgets.CategoryMultiselectWidget.SearchType.ParentCategories
+		// it can be the only search type.
+		if ( this.searchTypes.indexOf( mw.widgets.CategoryMultiselectWidget.SearchType.ParentCategories ) > -1 &&
+			this.searchTypes.length > 1
+		) {
+			throw new Error( 'Can\'t have additional search types with mw.widgets.CategoryMultiselectWidget.SearchType.ParentCategories' );
+		}
+
+		return true;
+	};
+
+	/**
+	 * Sets and validates the value of `this.searchType`.
+	 *
+	 * @param {mw.widgets.CategoryMultiselectWidget.SearchType[]} searchTypes
+	 */
+	mw.widgets.CategoryMultiselectWidget.prototype.setSearchTypes = function ( searchTypes ) {
+		this.searchTypes = searchTypes;
+		this.validateSearchTypes();
+	};
+
+	/**
+	 * Searches categories based on input and searchType.
+	 *
+	 * @private
+	 * @method
+	 * @param {string} input The input used to prefix search categories
+	 * @param {mw.widgets.CategoryMultiselectWidget.SearchType} searchType
+	 * @return {jQuery.Promise} Resolves with an array of categories
+	 */
+	mw.widgets.CategoryMultiselectWidget.prototype.searchCategories = function ( input, searchType ) {
+		var deferred = $.Deferred(),
+			cacheKey = input + searchType.toString();
+
+		// Check cache
+		if ( hasOwn.call( this.searchCache, cacheKey ) ) {
+			return this.searchCache[ cacheKey ];
+		}
+
+		switch ( searchType ) {
+			case mw.widgets.CategoryMultiselectWidget.SearchType.OpenSearch:
+				this.api.get( {
+					formatversion: 2,
+					action: 'opensearch',
+					namespace: NS_CATEGORY,
+					limit: this.limit,
+					search: input
+				} ).done( function ( res ) {
+					var categories = res[ 1 ];
+					deferred.resolve( categories );
+				} ).fail( deferred.reject.bind( deferred ) );
+				break;
+
+			case mw.widgets.CategoryMultiselectWidget.SearchType.InternalSearch:
+				this.api.get( {
+					formatversion: 2,
+					action: 'query',
+					list: 'allpages',
+					apnamespace: NS_CATEGORY,
+					aplimit: this.limit,
+					apfrom: input,
+					apprefix: input
+				} ).done( function ( res ) {
+					var categories = res.query.allpages.map( function ( page ) {
+						return page.title;
+					} );
+					deferred.resolve( categories );
+				} ).fail( deferred.reject.bind( deferred ) );
+				break;
+
+			case mw.widgets.CategoryMultiselectWidget.SearchType.Exists:
+				if ( input.indexOf( '|' ) > -1 ) {
+					deferred.resolve( [] );
+					break;
+				}
+
+				this.api.get( {
+					formatversion: 2,
+					action: 'query',
+					prop: 'info',
+					titles: 'Category:' + input
+				} ).done( function ( res ) {
+					var categories = [];
+
+					$.each( res.query.pages, function ( index, page ) {
+						if ( !page.missing ) {
+							categories.push( page.title );
+						}
+					} );
+
+					deferred.resolve( categories );
+				} ).fail( deferred.reject.bind( deferred ) );
+				break;
+
+			case mw.widgets.CategoryMultiselectWidget.SearchType.SubCategories:
+				if ( input.indexOf( '|' ) > -1 ) {
+					deferred.resolve( [] );
+					break;
+				}
+
+				this.api.get( {
+					formatversion: 2,
+					action: 'query',
+					list: 'categorymembers',
+					cmtype: 'subcat',
+					cmlimit: this.limit,
+					cmtitle: 'Category:' + input
+				} ).done( function ( res ) {
+					var categories = res.query.categorymembers.map( function ( category ) {
+						return category.title;
+					} );
+					deferred.resolve( categories );
+				} ).fail( deferred.reject.bind( deferred ) );
+				break;
+
+			case mw.widgets.CategoryMultiselectWidget.SearchType.ParentCategories:
+				if ( input.indexOf( '|' ) > -1 ) {
+					deferred.resolve( [] );
+					break;
+				}
+
+				this.api.get( {
+					formatversion: 2,
+					action: 'query',
+					prop: 'categories',
+					cllimit: this.limit,
+					titles: 'Category:' + input
+				} ).done( function ( res ) {
+					var categories = [];
+
+					$.each( res.query.pages, function ( index, page ) {
+						if ( !page.missing && Array.isArray( page.categories ) ) {
+							categories.push.apply( categories, page.categories.map( function ( category ) {
+								return category.title;
+							} ) );
+						}
+					} );
+
+					deferred.resolve( categories );
+				} ).fail( deferred.reject.bind( deferred ) );
+				break;
+
+			default:
+				throw new Error( 'Unknown searchType' );
+		}
+
+		// Cache the result
+		this.searchCache[ cacheKey ] = deferred.promise();
+
+		return deferred.promise();
+	};
+
+	/**
+	 * @enum mw.widgets.CategoryMultiselectWidget.SearchType
+	 * Types of search available.
+	 */
+	mw.widgets.CategoryMultiselectWidget.SearchType = {
+		/** Search using action=opensearch */
+		OpenSearch: 0,
+
+		/** Search using action=query */
+		InternalSearch: 1,
+
+		/** Search for existing categories with the exact title */
+		Exists: 2,
+
+		/** Search only subcategories */
+		SubCategories: 3,
+
+		/** Search only parent categories */
+		ParentCategories: 4
+	};
+}( jQuery, mediaWiki ) );