Merge "mw.ForeignStructuredUpload.BookletLayout: Make licensing links clickable again"

[lhc/web/wiklou.git] / resources / src / mediawiki.widgets / mw.widgets.SearchInputWidget.js

diff --git a/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js
old mode 100644 (file)
new mode 100755 (executable)
index 1f526e2..df03679
--- a/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js
+++ b/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js
@@ -15,12 +15,19 @@
         * @constructor
         * @cfg {boolean} [pushPending=true] Visually mark the input field as "pending", while
         *  requesting suggestions.
+        * @cfg {boolean} [performSearchOnClick=true] If true, the script will start a search when-
+        *  ever a user hits a suggestion. If false, the text of the suggestion is inserted into the
+        *  text field only.
+        *  @cfg {string} [dataLocation='header'] Where the search input field will be
+        *  used (header or content).
         */
        mw.widgets.SearchInputWidget = function MwWidgetsSearchInputWidget( config ) {
                config = $.extend( {
                        type: 'search',
                        icon: 'search',
-                       maxLength: undefined
+                       maxLength: undefined,
+                       performSearchOnClick: true,
+                       dataLocation: 'header'
                }, config );
 
                // Parent constructor
@@ -32,6 +39,12 @@
                if ( !config.pushPending ) {
                        this.pushPending = false;
                }
+               if ( config.dataLocation ) {
+                       this.dataLocation = config.dataLocation;
+               }
+               if ( config.performSearchOnClick ) {
+                       this.performSearchOnClick = config.performSearchOnClick;
+               }
                this.setLookupsDisabled( !this.suggestions );
        };
 
@@ -45,19 +58,39 @@
         * @inheritdoc mw.widgets.TitleWidget
         */
        mw.widgets.SearchInputWidget.prototype.getSuggestionsPromise = function () {
-               var api = new mw.Api();
+               var api = new mw.Api(),
+                       promise,
+                       self = this;
 
                // reuse the searchSuggest function from mw.searchSuggest
-               return mw.searchSuggest.request( api, this.getQueryValue(), $.noop, this.limit );
+               promise = mw.searchSuggest.request( api, this.getQueryValue(), $.noop, this.limit );
+
+               // tracking purposes
+               promise.done( function ( data, jqXHR ) {
+                       self.requestType = jqXHR.getResponseHeader( 'X-OpenSearch-Type' );
+               } );
+
+               return promise;
        };
 
        /**
         * @inheritdoc mw.widgets.TitleInputWidget
         */
        mw.widgets.SearchInputWidget.prototype.getLookupCacheDataFromResponse = function ( response ) {
+               var resp;
+
                // mw.widgets.TitleInputWidget uses response.query, which doesn't exist for opensearch,
                // so return the whole response (titles only, and links)
-               return response || {};
+               resp = {
+                       data: response || {},
+                       metadata: {
+                               type: this.requestType || 'unknown',
+                               query: this.getQueryValue()
+                       }
+               };
+               this.requestType = undefined;
+
+               return resp;
        };
 
        /**
@@ -70,17 +103,19 @@
                // mw.widgets.TitleWidget does a lot more work here, because the TitleOptionWidgets can
                // differ a lot, depending on the returned data from the request. With the request used here
                // we get only the search results.
-               $.each( data[ 1 ], function ( i, result ) {
+               $.each( data.data[ 1 ], function ( i, result ) {
                        items.push( new mw.widgets.TitleOptionWidget(
                                // data[ 3 ][ i ] is the link for this result
-                               self.getOptionWidgetData( result, null, data[ 3 ][ i ] )
+                               self.getOptionWidgetData( result, null, data.data[ 3 ][ i ] )
                        ) );
                } );
 
                mw.track( 'mw.widgets.SearchInputWidget', {
                        action: 'impression-results',
                        numberOfResults: items.length,
-                       resultSetType: mw.searchSuggest.type
+                       resultSetType: data.metadata.type,
+                       query: data.metadata.query,
+                       inputLocation: this.dataLocation || 'header'
                } );
 
                return items;
@@ -108,4 +143,26 @@
                };
        };
 
+       /**
+        * @inheritdoc
+        */
+       mw.widgets.SearchInputWidget.prototype.onLookupMenuItemChoose = function ( item ) {
+               var items;
+
+               // get items which was suggested before the input changes
+               items = this.lookupMenu.items;
+
+               mw.widgets.SearchInputWidget.parent.prototype.onLookupMenuItemChoose.apply( this, arguments );
+
+               mw.track( 'mw.widgets.SearchInputWidget', {
+                       action: 'click-result',
+                       numberOfResults: items.length,
+                       clickIndex: items.indexOf( item ) + 1
+               } );
+
+               if ( this.performSearchOnClick ) {
+                       this.$element.closest( 'form' ).submit();
+               }
+       };
+
 }( jQuery, mediaWiki ) );