mediawiki-extensions-Visual.../modules/ve-mw/ui/widgets/ve.ui.MWCategoryInputWidget.js
James D. Forrester df79ed8c4b Update VE core submodule to master (5befc34)
New changes:
3368c4c Remove some assumptions about the state of the context
79918af Move contexts to subfolder
820eaec Tests for some drag/drop functionality
e5f0e3e Convert CE surface tests to use a mock UI surface
c81dbcf Localisation updates from https://translatewiki.net.
7561ff3 Create a mock UI surface that only contains a model for model-only action tests
ad60333 Convert test timings on APIResultsQueue from seconds to milliseconds
b52d7df Table cursoring tests
3f8e821 Localisation updates from https://translatewiki.net.
9c737df Update OOjs UI to v0.11.4
5befc34 Stop using deprecated aliases for OO.ui.mixin.*

Change-Id: Ida6d4ba724686d8189975c55a18c4a6c2cfe4875
2015-06-10 12:44:55 -07:00

247 lines
6.9 KiB
JavaScript

/*!
* VisualEditor UserInterface MWCategoryInputWidget class.
*
* @copyright 2011-2015 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.MWCategoryInputWidget object.
*
* @class
* @extends OO.ui.TextInputWidget
* @mixins OO.ui.mixin.LookupElement
*
* @constructor
* @param {ve.ui.MWCategoryWidget} categoryWidget
* @param {Object} [config] Configuration options
*/
ve.ui.MWCategoryInputWidget = function VeUiMWCategoryInputWidget( categoryWidget, config ) {
// Config initialization
config = ve.extendObject( {
placeholder: ve.msg( 'visualeditor-dialog-meta-categories-input-placeholder' )
}, config );
// Parent constructor
OO.ui.TextInputWidget.call( this, config );
// Mixin constructors
OO.ui.mixin.LookupElement.call( this, config );
// Properties
this.categoryWidget = categoryWidget;
// Initialization
this.$element.addClass( 've-ui-mwCategoryInputWidget' );
this.lookupMenu.$element.addClass( 've-ui-mwCategoryInputWidget-menu' );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWCategoryInputWidget, OO.ui.TextInputWidget );
OO.mixinClass( ve.ui.MWCategoryInputWidget, OO.ui.mixin.LookupElement );
/* Events */
/**
* @event choose
* A category was chosen
* @param {OO.ui.MenuOptionWidget} item Chosen item
*/
/* Methods */
/**
* @inheritdoc
*/
ve.ui.MWCategoryInputWidget.prototype.getLookupRequest = function () {
return new mw.Api().get( {
action: 'query',
generator: 'allcategories',
gacmin: 1,
gacprefix: this.value,
prop: 'categoryinfo',
redirects: ''
} );
};
/**
* @inheritdoc
*/
ve.ui.MWCategoryInputWidget.prototype.getLookupCacheDataFromResponse = function ( data ) {
var result = [],
linkCacheUpdate = {},
query = data.query || {};
$.each( query.pages || [], function ( pageId, categoryPage ) {
result.push( mw.Title.newFromText( categoryPage.title ).getMainText() );
linkCacheUpdate[categoryPage.title] = {
missing: categoryPage.hasOwnProperty( 'missing' ),
hidden: categoryPage.categoryinfo && categoryPage.categoryinfo.hasOwnProperty( 'hidden' )
};
} );
$.each( query.redirects || [], function ( index, redirect ) {
if ( !linkCacheUpdate.hasOwnProperty( redirect.to ) ) {
linkCacheUpdate[redirect.to] = ve.init.platform.linkCache.getCached( redirect.to ) ||
{ missing: false, redirectFrom: [redirect.from] };
}
if (
linkCacheUpdate[redirect.to].redirectFrom &&
linkCacheUpdate[redirect.to].redirectFrom.indexOf( redirect.from ) === -1
) {
linkCacheUpdate[redirect.to].redirectFrom.push( redirect.from );
} else {
linkCacheUpdate[redirect.to].redirectFrom = [redirect.from];
}
} );
ve.init.platform.linkCache.set( linkCacheUpdate );
return result;
};
/**
* @inheritdoc
*/
ve.ui.MWCategoryInputWidget.prototype.getLookupMenuOptionsFromData = function ( data ) {
var widget = this,
exactMatch = false,
itemWidgets = [],
existingCategoryItems = [],
matchingCategoryItems = [],
hiddenCategoryItems = [],
newCategoryItems = [],
existingCategories = this.categoryWidget.getCategories(),
linkCacheUpdate = {},
canonicalQueryValue = mw.Title.newFromText( this.value ),
prefixedCanonicalQueryValue = mw.Title.newFromText(
this.value,
mw.config.get( 'wgNamespaceIds' ).category
);
prefixedCanonicalQueryValue = prefixedCanonicalQueryValue && prefixedCanonicalQueryValue.getPrefixedText();
// Invalid titles end up with canonicalQueryValue being null.
if ( canonicalQueryValue ) {
canonicalQueryValue = canonicalQueryValue.getMainText();
}
$.each( data, function ( index, suggestedCategory ) {
var suggestedCategoryTitle = mw.Title.newFromText(
suggestedCategory,
mw.config.get( 'wgNamespaceIds' ).category
).getPrefixedText(),
suggestedCacheEntry = ve.init.platform.linkCache.getCached( suggestedCategoryTitle );
if ( canonicalQueryValue === suggestedCategory ) {
exactMatch = true;
}
if ( !suggestedCacheEntry ) {
linkCacheUpdate[suggestedCategoryTitle] = { missing: false };
}
if (
existingCategories.indexOf( suggestedCategory ) === -1
) {
if ( suggestedCacheEntry && suggestedCacheEntry.hidden ) {
hiddenCategoryItems.push( suggestedCategory );
} else {
matchingCategoryItems.push( suggestedCategory );
}
}
} );
// Existing categories
$.each( existingCategories, function ( index, existingCategory ) {
if ( existingCategory === canonicalQueryValue ) {
exactMatch = true;
}
if ( index < existingCategories.length - 1 && existingCategory.lastIndexOf( canonicalQueryValue, 0 ) === 0 ) {
// Verify that item starts with category.value
existingCategoryItems.push( existingCategory );
}
} );
// New category
if ( !exactMatch && canonicalQueryValue ) {
newCategoryItems.push( canonicalQueryValue );
linkCacheUpdate[prefixedCanonicalQueryValue] = { missing: true };
}
ve.init.platform.linkCache.set( linkCacheUpdate );
// Add sections for non-empty groups. Each section consists of an id, a label and items
$.each( [
{
id: 'newCategory',
label: ve.msg( 'visualeditor-dialog-meta-categories-input-newcategorylabel' ),
items: newCategoryItems
},
{
id: 'inArticle',
label: ve.msg( 'visualeditor-dialog-meta-categories-input-movecategorylabel' ),
items: existingCategoryItems
},
{
id: 'matchingCategories',
label: ve.msg( 'visualeditor-dialog-meta-categories-input-matchingcategorieslabel' ),
items: matchingCategoryItems
},
{
id: 'hiddenCategories',
label: ve.msg( 'visualeditor-dialog-meta-categories-input-hiddencategorieslabel' ),
items: hiddenCategoryItems
}
], function ( index, sectionData ) {
if ( sectionData.items.length ) {
itemWidgets.push( new OO.ui.MenuSectionOptionWidget( {
data: sectionData.id,
label: sectionData.label
} ) );
$.each( sectionData.items, function ( index, categoryItem ) {
itemWidgets.push( widget.getCategoryWidgetFromName( categoryItem ) );
} );
}
} );
return itemWidgets;
};
/**
* @inheritdoc
*/
ve.ui.MWCategoryInputWidget.prototype.onLookupMenuItemChoose = function ( item ) {
this.emit( 'choose', item );
// Reset input
this.setValue( '' );
};
/**
* Take a category name and turn it into a menu item widget, following redirects.
*
* @method
* @param {string} name Category name
* @returns {OO.ui.MenuOptionWidget} Menu item widget to be shown
*/
ve.ui.MWCategoryInputWidget.prototype.getCategoryWidgetFromName = function ( name ) {
var cachedData = ve.init.platform.linkCache.getCached(
mw.Title.newFromText( name, mw.config.get( 'wgNamespaceIds' ).category ).getPrefixedText()
);
if ( cachedData && cachedData.redirectFrom ) {
return new OO.ui.MenuOptionWidget( {
data: name,
autoFitLabel: false,
label: $( '<span>' )
.text( mw.Title.newFromText( cachedData.redirectFrom[0] ).getMainText() )
.append( '<br>↳ ' )
.append( $( '<span>' ).text( mw.Title.newFromText( name ).getMainText() ) )
} );
} else {
return new OO.ui.MenuOptionWidget( {
data: name,
label: name
} );
}
};