/*! * VisualEditor UserInterface MWTemplateTitleInputWidget class. * * @copyright 2011-2016 VisualEditor Team and others; see AUTHORS.txt * @license The MIT License (MIT); see LICENSE.txt */ /** * Creates an ve.ui.MWTemplateTitleInputWidget object. * * @class * @extends mw.widgets.TitleInputWidget * * @constructor * @param {Object} [config] Configuration options * @cfg {number} [namespace] Namespace to prepend to queries. Defaults to template namespace. */ ve.ui.MWTemplateTitleInputWidget = function VeUiMWTemplateTitleInputWidget( config ) { config = ve.extendObject( {}, { namespace: mw.config.get( 'wgNamespaceIds' ).template }, config ); // Parent constructor ve.ui.MWTemplateTitleInputWidget.super.call( this, config ); this.showTemplateDescriptions = this.showDescriptions; // Clear the showDescriptions flag for subsequent requests as we implement // description fetch ourselves this.showDescriptions = false; // Properties this.descriptions = {}; // Initialization this.$element.addClass( 've-ui-mwTemplateTitleInputWidget' ); }; /* Inheritance */ OO.inheritClass( ve.ui.MWTemplateTitleInputWidget, mw.widgets.TitleInputWidget ); /* Methods */ /** * See the parent documentation at */ ve.ui.MWTemplateTitleInputWidget.prototype.getLookupRequest = function () { var widget = this, originalResponse, promise = ve.ui.MWTemplateTitleInputWidget.super.prototype.getLookupRequest.call( this ); if ( this.showTemplateDescriptions ) { return promise .then( function ( response ) { var xhr, pageId, index, params, redirIndex, redirects = ( response.query && response.query.redirects ) || {}, origPages = ( response.query && response.query.pages ) || {}, newPages = [], titles = []; // Build a new array to replace response.query.pages, ensuring everything goes into // the order defined by the page's index key, instead of whatever random order the // browser would let you iterate over the old object in. for ( pageId in origPages ) { if ( 'index' in origPages[ pageId ] ) { newPages[ origPages[ pageId ].index - 1 ] = origPages[ pageId ]; } else { // Watch out for cases where the index is specified on the redirect object // rather than the page object. for ( redirIndex in redirects ) { if ( redirects[ redirIndex ].to === origPages[ pageId ].title ) { newPages[ redirects[ redirIndex ].index - 1 ] = origPages[ pageId ]; break; } } } } for ( index in newPages ) { titles.push( newPages[ index ].title ); } ve.setProp( response, 'query', 'pages', newPages ); originalResponse = response; // lie! // Also get descriptions if ( titles.length > 0 ) { params = { action: 'templatedata', titles: titles.join( '|' ), lang: mw.config.get( 'wgUserLanguage' ) }; if ( widget.showRedirects ) { params.redirects = '1'; } xhr = this.getApi().get( params ); return xhr.promise( { abort: xhr.abort } ); } } ) .then( function ( templateDataResponse ) { var index, page, pages = ( templateDataResponse && templateDataResponse.pages ) || {}; // Look for descriptions and cache them for ( index in pages ) { page = pages[ index ]; // Cache descriptions widget.descriptions[ page.title ] = page.description; } // Return the original response return originalResponse; } ) .promise( { abort: function () {} } ); } return promise; }; /** * See the parent documentation at * * @param {string} title * @return {Object} */ ve.ui.MWTemplateTitleInputWidget.prototype.getOptionWidgetData = function ( title ) { return ve.extendObject( ve.ui.MWTemplateTitleInputWidget.super.prototype.getOptionWidgetData.apply( this, arguments ), { description: this.descriptions[ title ] } ); };