1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
|
/*!
* VisualEditor UserInterface MWCategoryWidget class.
*
* @copyright See AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.MWCategoryWidget object.
*
* @class
* @abstract
* @extends OO.ui.Widget
* @mixes OO.ui.mixin.GroupElement
* @mixes OO.ui.mixin.DraggableGroupElement
*
* @constructor
* @param {Object} [config] Configuration options
* @param {jQuery} [config.$overlay] Overlay to render dropdowns in
*/
ve.ui.MWCategoryWidget = function VeUiMWCategoryWidget( config ) {
// Config initialization
config = config || {};
// Parent constructor
ve.ui.MWCategoryWidget.super.call( this, config );
// Mixin constructors
OO.ui.mixin.GroupElement.call( this, config );
OO.ui.mixin.DraggableGroupElement.call( this, ve.extendObject( {}, config, { orientation: 'horizontal' } ) );
const categoryNamespace = mw.config.get( 'wgNamespaceIds' ).category;
// Properties
this.fragment = null;
this.categories = {};
// Source -> target
this.categoryRedirects = {};
// Title cache - will contain entries even if title is already normalized
this.normalizedTitles = {};
this.popup = new ve.ui.MWCategoryPopupWidget();
this.input = new ve.ui.MWCategoryInputWidget( this, { $overlay: config.$overlay } );
this.forceCapitalization = mw.config.get( 'wgCaseSensitiveNamespaces' ).indexOf( categoryNamespace ) === -1;
this.categoryPrefix = mw.config.get( 'wgFormattedNamespaces' )[ categoryNamespace ] + ':';
this.expandedItem = null;
// Events
this.input.connect( this, { choose: 'onInputChoose' } );
this.popup.connect( this, {
removeCategory: 'onRemoveCategory',
updateSortkey: 'onUpdateSortkey',
ready: 'onPopupOpened',
closing: 'onPopupClosing'
} );
this.connect( this, {
drag: 'onDrag'
} );
// Initialization
this.$element.addClass( 've-ui-mwCategoryWidget' )
.append(
this.$group.addClass( 've-ui-mwCategoryWidget-items' ).append(
this.input.$element
),
this.popup.$element,
$( '<div>' ).css( 'clear', 'both' )
);
};
/* Inheritance */
OO.inheritClass( ve.ui.MWCategoryWidget, OO.ui.Widget );
OO.mixinClass( ve.ui.MWCategoryWidget, OO.ui.mixin.GroupElement );
OO.mixinClass( ve.ui.MWCategoryWidget, OO.ui.mixin.DraggableGroupElement );
/* Events */
/**
* @event ve.ui.MWCategoryWidget#newCategory
* @param {Object} item Category item
* @param {string} item.name Fully prefixed category name
* @param {string} item.value Category value (name without prefix)
* @param {ve.dm.MWCategoryMetaItem} item.metaItem
* @param {ve.dm.MetaItem} [beforeCategory] Insert after this category; if unset, insert at the end
*/
/**
* @event ve.ui.MWCategoryWidget#updateSortkey
* @param {Object} item Category item
* @param {string} item.name Fully prefixed category name
* @param {string} item.value Category value (name without prefix)
* @param {ve.dm.MWCategoryMetaItem} item.metaItem
*/
/* Methods */
/**
* Surface fragment for modifying meta list
*
* @param {ve.dm.SurfaceFragment|null} fragment Surface fragment
*/
ve.ui.MWCategoryWidget.prototype.setFragment = function ( fragment ) {
this.fragment = fragment;
};
/**
* Handle input 'choose' event.
*
* @param {OO.ui.MenuOptionWidget} item Selected item
*/
ve.ui.MWCategoryWidget.prototype.onInputChoose = function ( item ) {
const value = item.getData();
if ( value && value !== '' ) {
// Add new item
const categoryItem = this.getCategoryItemFromValue( value );
this.queryCategoryStatus( [ categoryItem.name ] ).done( () => {
// Remove existing items by name
const toRemove = mw.Title.newFromText( categoryItem.name ).getMainText();
if ( Object.prototype.hasOwnProperty.call( this.categories, toRemove ) ) {
this.fragment.removeMeta( this.categories[ toRemove ].metaItem );
}
categoryItem.name = this.normalizedTitles[ categoryItem.name ];
this.emit( 'newCategory', categoryItem );
} );
}
};
/**
* Hanle popup open event
*
*/
ve.ui.MWCategoryWidget.prototype.onPopupOpened = function () {
this.popup.removeButton.focus();
};
/**
* Handle popup closing dialog
*/
ve.ui.MWCategoryWidget.prototype.onPopupClosing = function () {
this.expandedItem.focus();
};
/**
* Get a category item.
*
* @param {string} value Category name
* @return {Object} Category item with name, value and metaItem properties
*/
ve.ui.MWCategoryWidget.prototype.getCategoryItemFromValue = function ( value ) {
// Normalize
const title = mw.Title.newFromText( this.categoryPrefix + value );
if ( title ) {
return {
name: title.getPrefixedText(),
value: title.getMainText(),
metaItem: {}
};
}
if ( this.forceCapitalization ) {
value = value.slice( 0, 1 ).toUpperCase() + value.slice( 1 );
}
return {
name: this.categoryPrefix + value,
value: value,
metaItem: {}
};
};
/**
* Focus the widget
*/
ve.ui.MWCategoryWidget.prototype.focus = function () {
this.input.$input[ 0 ].focus();
};
/**
* @param {ve.ui.MWCategoryItemWidget} item Item that was moved
* @param {number} newIndex The new index of the item
*/
ve.ui.MWCategoryWidget.prototype.onDrag = function () {
this.fitInput();
};
/**
* @inheritdoc OO.ui.mixin.DraggableGroupElement
* @fires ve.ui.MWCategoryWidget#newCategory
*/
ve.ui.MWCategoryWidget.prototype.reorder = function ( item, newIndex ) {
// Compute beforeCategory before removing, otherwise newIndex
// could be off by one
const beforeCategory = this.items[ newIndex ] && this.items[ newIndex ].metaItem;
if ( Object.prototype.hasOwnProperty.call( this.categories, item.value ) ) {
this.fragment.removeMeta( this.categories[ item.value ].metaItem );
}
this.emit( 'newCategory', item, beforeCategory );
};
/**
* Removes category from model.
*
* @param {string} name Removed category name
*/
ve.ui.MWCategoryWidget.prototype.onRemoveCategory = function ( name ) {
this.fragment.removeMeta( this.categories[ name ].metaItem );
delete this.categories[ name ];
};
/**
* Update sortkey value, emit updateSortkey event
*
* @param {string} name
* @param {string} value
* @fires ve.ui.MWCategoryWidget#updateSortkey
*/
ve.ui.MWCategoryWidget.prototype.onUpdateSortkey = function ( name, value ) {
this.categories[ name ].sortKey = value;
this.emit( 'updateSortkey', this.categories[ name ] );
};
/**
* @inheritdoc
*/
ve.ui.MWCategoryWidget.prototype.clearItems = function () {
OO.ui.mixin.GroupElement.prototype.clearItems.call( this );
this.categories = {};
};
/**
* Toggles popup menu per category item
*
* @param {Object} item
*/
ve.ui.MWCategoryWidget.prototype.onTogglePopupMenu = function ( item ) {
// Close open popup.
if ( item.value !== this.popup.category ) {
this.popup.openPopup( item );
this.expandedItem = item;
this.popup
.$element
.attr( 'aria-label',
ve.msg( 'visualeditor-dialog-meta-categories-category' )
);
} else {
// Handle toggle
this.popup.closePopup();
}
};
/**
* Set the default sort key.
*
* @param {string} value Default sort key value
*/
ve.ui.MWCategoryWidget.prototype.setDefaultSortKey = function ( value ) {
this.popup.setDefaultSortKey( value );
};
/**
* @inheritdoc
*/
ve.ui.MWCategoryWidget.prototype.setDisabled = function () {
// Parent method
ve.ui.MWCategoryWidget.super.prototype.setDisabled.apply( this, arguments );
const isDisabled = this.isDisabled();
if ( this.input ) {
this.input.setDisabled( isDisabled );
}
if ( this.items ) {
this.items.forEach( ( item ) => {
item.setDisabled( isDisabled );
} );
}
if ( this.popup ) {
this.popup.closePopup();
}
};
/**
* Get list of category names.
*
* @return {string[]} List of category names
*/
ve.ui.MWCategoryWidget.prototype.getCategories = function () {
return Object.keys( this.categories );
};
/**
* Starts a request to update the link cache's hidden and missing status for
* the given titles, following normalisation responses as necessary.
*
* @param {string[]} categoryNames
* @return {jQuery.Promise}
*/
ve.ui.MWCategoryWidget.prototype.queryCategoryStatus = function ( categoryNames ) {
// Get rid of any we already know the hidden status of, or have an entry
// if normalizedTitles (i.e. have been fetched before)
const categoryNamesToQuery = categoryNames.filter( ( name ) => {
if ( this.normalizedTitles[ name ] ) {
return false;
}
const cacheEntry = ve.init.platform.linkCache.getCached( name );
if ( cacheEntry && cacheEntry.hidden ) {
// As we aren't doing an API request for this category, mark it in the cache.
this.normalizedTitles[ name ] = name;
return false;
}
return true;
} );
if ( !categoryNamesToQuery.length ) {
return ve.createDeferred().resolve( {} ).promise();
}
let index = 0;
const batchSize = 50, promises = [];
// Batch this up into groups of 50
while ( index < categoryNamesToQuery.length ) {
promises.push( ve.init.target.getContentApi().get( {
action: 'query',
prop: 'pageprops',
titles: categoryNamesToQuery.slice( index, index + batchSize ),
ppprop: 'hiddencat',
redirects: ''
} ).then( ( result ) => {
const linkCacheUpdate = {},
normalizedTitles = {};
if ( result && result.query && result.query.pages ) {
result.query.pages.forEach( ( pageInfo ) => {
linkCacheUpdate[ pageInfo.title ] = {
missing: Object.prototype.hasOwnProperty.call( pageInfo, 'missing' ),
hidden: pageInfo.pageprops &&
Object.prototype.hasOwnProperty.call( pageInfo.pageprops, 'hiddencat' )
};
} );
}
if ( result && result.query && result.query.redirects ) {
result.query.redirects.forEach( ( redirectInfo ) => {
this.categoryRedirects[ redirectInfo.from ] = redirectInfo.to;
} );
}
ve.init.platform.linkCache.set( linkCacheUpdate );
if ( result.query && result.query.normalized ) {
result.query.normalized.forEach( ( normalisation ) => {
normalizedTitles[ normalisation.from ] = normalisation.to;
} );
}
categoryNames.forEach( ( name ) => {
this.normalizedTitles[ name ] = normalizedTitles[ name ] || name;
} );
} ) );
index += batchSize;
}
return ve.promiseAll( promises );
};
/**
* Adds category items.
*
* @param {Object[]} items Items to add
* @param {number} [index] Index to insert items after
* @return {jQuery.Promise}
*/
ve.ui.MWCategoryWidget.prototype.addItems = function ( items, index ) {
const categoryItems = [],
// eslint-disable-next-line no-jquery/no-map-util
categoryNames = $.map( items, ( item ) => item.name );
return this.queryCategoryStatus( categoryNames ).then( () => {
let config;
const checkValueMatches = function ( existingCategoryItem ) {
return config.item.value === existingCategoryItem.value;
};
items.forEach( ( item ) => {
item.name = this.normalizedTitles[ item.name ];
const itemTitle = new mw.Title( item.name, mw.config.get( 'wgNamespaceIds' ).category );
// Create a widget using the item data
config = {
item: item
};
let cachedData;
if ( Object.prototype.hasOwnProperty.call( this.categoryRedirects, itemTitle.getPrefixedText() ) ) {
config.redirectTo = new mw.Title(
this.categoryRedirects[ itemTitle.getPrefixedText() ],
mw.config.get( 'wgNamespaceIds' ).category
).getMainText();
cachedData = ve.init.platform.linkCache.getCached( this.categoryRedirects[ itemTitle.getPrefixedText() ] );
} else {
cachedData = ve.init.platform.linkCache.getCached( item.name );
}
config.hidden = cachedData.hidden;
config.missing = cachedData.missing;
config.disabled = this.disabled;
const categoryItem = new ve.ui.MWCategoryItemWidget( config );
categoryItem.connect( this, {
togglePopupMenu: 'onTogglePopupMenu'
} );
// Index item
this.categories[ itemTitle.getMainText() ] = categoryItem;
// Copy sortKey from old item when "moving"
const existingCategoryItems = this.items.filter( checkValueMatches );
if ( existingCategoryItems.length ) {
// There should only be one element in existingCategoryItems
categoryItem.sortKey = existingCategoryItems[ 0 ].sortKey;
this.removeItems( [ existingCategoryItems[ 0 ] ] );
}
categoryItems.push( categoryItem );
} );
OO.ui.mixin.DraggableGroupElement.prototype.addItems.call( this, categoryItems, index );
// Ensure the input remains the last item in the list, and preserve focus
const hadFocus = this.getElementDocument().activeElement === this.input.$input[ 0 ];
this.$group.append( this.input.$element );
if ( hadFocus ) {
this.input.$input[ 0 ].focus();
}
this.fitInput();
} );
};
/**
* @inheritdoc
*/
ve.ui.MWCategoryWidget.prototype.removeItems = function ( items ) {
for ( let i = 0, len = items.length; i < len; i++ ) {
const categoryItem = items[ i ];
if ( categoryItem ) {
categoryItem.disconnect( this );
items.push( categoryItem );
delete this.categories[ categoryItem.value ];
}
}
OO.ui.mixin.DraggableGroupElement.prototype.removeItems.call( this, items );
this.fitInput();
};
/**
* Auto-fit the input.
*/
ve.ui.MWCategoryWidget.prototype.fitInput = function () {
const $input = this.input.$element;
// eslint-disable-next-line no-jquery/no-sizzle
if ( !this.items.length || !$input.is( ':visible' ) ) {
return;
}
// Measure the input's natural size
$input.css( 'width', '' );
const inputWidth = $input.outerWidth( true );
// this.items hasn't been updated if this was triggered by a drag event,
// so look at document order
const $lastItem = this.$group.find( '.ve-ui-mwCategoryItemWidget' ).last();
// Try to fit to the right of the last item
const availableSpace = Math.floor( this.$group.width() - ( $lastItem.position().left + $lastItem.outerWidth( true ) ) );
if ( availableSpace > inputWidth ) {
$input.css( 'width', availableSpace );
}
};
|