wikimedia/mediawiki-extensions-VisualEditor

/*!
 * VisualEditor UserInterface MWEditSummaryWidget class.
 *
 * @copyright See AUTHORS.txt
 */

/**
 * Multi line text input for edit summary, with auto completion based on
 * the user's previous edit summaries.
 *
 * @class
 * @extends OO.ui.MultilineTextInputWidget
 * @mixes OO.ui.mixin.LookupElement
 *
 * @constructor
 * @param {Object} [config] Configuration options
 * @param {number} [config.limit=6] Number of suggestions to show
 */
ve.ui.MWEditSummaryWidget = function VeUiMWEditSummaryWidget( config ) {
    config = config || {};

    // Parent method
    ve.ui.MWEditSummaryWidget.super.call( this, ve.extendObject( {
        autosize: true,
        maxRows: 15,
        allowLinebreaks: false
    }, config ) );

    // Mixin method
    OO.ui.mixin.LookupElement.call( this, ve.extendObject( {
        showPendingRequest: false,
        showSuggestionsOnFocus: false,
        allowSuggestionsWhenEmpty: false,
        highlightFirst: false
    }, config ) );

    this.limit = config.limit || 6;
};

/* Inheritance */

OO.inheritClass( ve.ui.MWEditSummaryWidget, OO.ui.MultilineTextInputWidget );

OO.mixinClass( ve.ui.MWEditSummaryWidget, OO.ui.mixin.LookupElement );

/* Static properties */

ve.ui.MWEditSummaryWidget.static.summarySplitter = /^(\/\*.*?\*\/\s*)?([^]*)$/;

/* Static methods */

/**
 * Split a summary into the section and the actual summary
 *
 * @param {string} summary
 * @return {Object} Object with section and comment string properties
 */
ve.ui.MWEditSummaryWidget.static.splitSummary = function ( summary ) {
    const result = summary.match( this.summarySplitter );
    return {
        section: result[ 1 ] || '',
        comment: result[ 2 ]
    };
};

/**
 * Filter a list of edit summaries to a specific query string
 *
 * @param {string[]} summaries Edit summaries
 * @param {string} query User query
 * @return {string[]} Filtered edit summaries
 */
ve.ui.MWEditSummaryWidget.static.getMatchingSummaries = function ( summaries, query ) {
    const summaryPrefixMatches = [], wordPrefixMatches = [], otherMatches = [],
        lowerQuery = query.toLowerCase();

    if ( !query.trim() ) {
        // Show no results for empty query
        return [];
    }

    summaries.forEach( ( summary ) => {
        const lowerSummary = summary.toLowerCase(),
            index = lowerSummary.indexOf( lowerQuery );
        if ( index === 0 ) {
            // Exclude exact matches
            if ( lowerQuery !== summary ) {
                summaryPrefixMatches.push( summary );
            }
        } else if ( index !== -1 ) {
            if ( /^\s/.test( lowerSummary.charAt( index - 1 ) ) ) {
                // Character before match is whitespace
                wordPrefixMatches.push( summary );
            } else {
                otherMatches.push( summary );
            }
        }
    } );
    return summaryPrefixMatches.concat( wordPrefixMatches, otherMatches );
};

/* Methods */

/**
 * @inheritdoc
 */
ve.ui.MWEditSummaryWidget.prototype.adjustSize = function () {
    // To autosize, the widget will render another element beneath the input
    // with the same text for measuring. This extra element could cause scrollbars
    // to appear, changing the available width, so if scrollbars are intially
    // hidden, force them to stay hidden during the adjustment.
    // TODO: Consider upstreaming this?
    const scrollContainer = this.getClosestScrollableElementContainer();
    const hasScrollbar = scrollContainer.offsetWidth > scrollContainer.scrollWidth;
    let overflowY;
    if ( !hasScrollbar ) {
        overflowY = scrollContainer.style.overflowY;
        scrollContainer.style.overflowY = 'hidden';
    }

    // Parent method
    ve.ui.MWEditSummaryWidget.super.prototype.adjustSize.apply( this, arguments );

    if ( !hasScrollbar ) {
        scrollContainer.style.overflowY = overflowY;
    }

    return this;
};

/**
 * Get recent edit summaries for the logged in user
 *
 * @return {jQuery.Promise} Promise which resolves with a list of summaries
 */
ve.ui.MWEditSummaryWidget.prototype.getSummaries = function () {
    const splitSummary = this.constructor.static.splitSummary.bind( this.constructor.static );
    if ( !this.getSummariesPromise ) {
        if ( mw.user.isAnon() ) {
            this.getSummariesPromise = ve.createDeferred().resolve( [] ).promise();
        } else {
            // Allow this for temp users as well. The isAnon() check above is just to avoid autocompleting
            // with someone else's summaries.
            this.getSummariesPromise = ve.init.target.getLocalApi().get( {
                action: 'query',
                list: 'usercontribs',
                ucuser: mw.user.getName(),
                ucprop: 'comment',
                uclimit: 500
            } ).then( ( response ) => {
                const usedComments = {},
                    changes = ve.getProp( response, 'query', 'usercontribs' ) || [];

                return changes
                    // Filter out changes without comment (e.g. due to RevisionDelete)
                    .filter( ( change ) => Object.prototype.hasOwnProperty.call( change, 'comment' ) )
                    // Remove section /* headings */
                    .map( ( change ) => splitSummary( change.comment ).comment.trim() )
                    // Filter out duplicates and empty comments
                    .filter( ( comment ) => {
                        if ( !comment || Object.prototype.hasOwnProperty.call( usedComments, comment ) ) {
                            return false;
                        }
                        usedComments[ comment ] = true;
                        return true;
                    } )
                    .sort();
            } );
        }
    }
    return this.getSummariesPromise;
};

/**
 * @inheritdoc
 */
ve.ui.MWEditSummaryWidget.prototype.getLookupRequest = function () {
    const query = this.constructor.static.splitSummary( this.value ),
        limit = this.limit;

    return this.getSummaries().then( ( allSummaries ) => {
        const matchingSummaries = this.constructor.static.getMatchingSummaries( allSummaries, query.comment );
        if ( matchingSummaries.length > limit ) {
            // Quick in-place truncate
            matchingSummaries.length = limit;
        }
        return { summaries: matchingSummaries, section: query.section };
    } ).promise( { abort: () => {} } ); // don't abort, the actual request will be the same anyway
};

/**
 * @inheritdoc
 */
ve.ui.MWEditSummaryWidget.prototype.getLookupCacheDataFromResponse = function ( response ) {
    return response;
};

/**
 * @inheritdoc
 */
ve.ui.MWEditSummaryWidget.prototype.getLookupMenuOptionsFromData = function ( data ) {
    return data.summaries.map( ( item ) => new OO.ui.MenuOptionWidget( {
        label: item,
        data: data.section + item
    } ) );
};