resources/src/mediawiki/mediawiki.searchSuggest.js

   1 /*!
   2  * Add search suggestions to the search form.
   3  */
   4 ( function ( mw, $ ) {
   5         $( function () {
   6                 var map, resultRenderCache, searchboxesSelectors,
   7                         // Region where the suggestions box will appear directly below
   8                         // (using the same width). Can be a container element or the input
   9                         // itself, depending on what suits best in the environment.
  10                         // For Vector the suggestion box should align with the simpleSearch
  11                         // container's borders, in other skins it should align with the input
  12                         // element (not the search form, as that would leave the buttons
  13                         // vertically between the input and the suggestions).
  14                         $searchRegion = $( '#simpleSearch, #searchInput' ).first(),
  15                         $searchInput = $( '#searchInput' );
  16
  17                 // Compatibility map
  18                 map = {
  19                         // SimpleSearch is broken in Opera < 9.6
  20                         opera: [['>=', 9.6]],
  21                         // Older Konquerors are unable to position the suggestions correctly (bug 50805)
  22                         konqueror: [['>=', '4.11']],
  23                         docomo: false,
  24                         blackberry: false,
  25                         ipod: false,
  26                         iphone: false
  27                 };
  28
  29                 if ( !$.client.test( map ) ) {
  30                         return;
  31                 }
  32
  33                 // Compute form data for search suggestions functionality.
  34                 function computeResultRenderCache( context ) {
  35                         var $form, baseHref, linkParams;
  36
  37                         // Compute common parameters for links' hrefs
  38                         $form = context.config.$region.closest( 'form' );
  39
  40                         baseHref = $form.attr( 'action' );
  41                         baseHref += baseHref.indexOf( '?' ) > -1 ? '&' : '?';
  42
  43                         linkParams = {};
  44                         $.each( $form.serializeArray(), function ( idx, obj ) {
  45                                 linkParams[ obj.name ] = obj.value;
  46                         } );
  47
  48                         return {
  49                                 textParam: context.data.$textbox.attr( 'name' ),
  50                                 linkParams: linkParams,
  51                                 baseHref: baseHref
  52                         };
  53                 }
  54
  55                 // The function used to render the suggestions.
  56                 function renderFunction( text, context ) {
  57                         if ( !resultRenderCache ) {
  58                                 resultRenderCache = computeResultRenderCache( context );
  59                         }
  60
  61                         // linkParams object is modified and reused
  62                         resultRenderCache.linkParams[ resultRenderCache.textParam ] = text;
  63
  64                         // this is the container <div>, jQueryfied
  65                         this.text( text )
  66                                 .wrap(
  67                                         $( '<a>' )
  68                                                 .attr( 'href', resultRenderCache.baseHref + $.param( resultRenderCache.linkParams ) )
  69                                                 .addClass( 'mw-searchSuggest-link' )
  70                                 );
  71                 }
  72
  73                 function specialRenderFunction( query, context ) {
  74                         var $el = this;
  75
  76                         if ( !resultRenderCache ) {
  77                                 resultRenderCache = computeResultRenderCache( context );
  78                         }
  79
  80                         // linkParams object is modified and reused
  81                         resultRenderCache.linkParams[ resultRenderCache.textParam ] = query;
  82
  83                         if ( $el.children().length === 0 ) {
  84                                 $el
  85                                         .append(
  86                                                 $( '<div>' )
  87                                                         .addClass( 'special-label' )
  88                                                         .text( mw.msg( 'searchsuggest-containing' ) ),
  89                                                 $( '<div>' )
  90                                                         .addClass( 'special-query' )
  91                                                         .text( query )
  92                                         )
  93                                         .show();
  94                         } else {
  95                                 $el.find( '.special-query' )
  96                                         .text( query );
  97                         }
  98
  99                         if ( $el.parent().hasClass( 'mw-searchSuggest-link' ) ) {
 100                                 $el.parent().attr( 'href', resultRenderCache.baseHref + $.param( resultRenderCache.linkParams ) + '&fulltext=1' );
 101                         } else {
 102                                 $el.wrap(
 103                                         $( '<a>' )
 104                                                 .attr( 'href', resultRenderCache.baseHref + $.param( resultRenderCache.linkParams ) + '&fulltext=1' )
 105                                                 .addClass( 'mw-searchSuggest-link' )
 106                                 );
 107                         }
 108                 }
 109
 110                 // Generic suggestions functionality for all search boxes
 111                 searchboxesSelectors = [
 112                         // Primary searchbox on every page in standard skins
 113                         '#searchInput',
 114                         // Special:Search
 115                         '#powerSearchText',
 116                         '#searchText',
 117                         // Generic selector for skins with multiple searchboxes (used by CologneBlue)
 118                         // and for MediaWiki itself (special pages with page title inputs)
 119                         '.mw-searchInput'
 120                 ];
 121                 $( searchboxesSelectors.join( ', ' ) )
 122                         .suggestions( {
 123                                 fetch: function ( query ) {
 124                                         var $el;
 125
 126                                         if ( query.length !== 0 ) {
 127                                                 $el = $( this );
 128                                                 $el.data( 'request', ( new mw.Api() ).get( {
 129                                                         action: 'opensearch',
 130                                                         search: query,
 131                                                         namespace: 0,
 132                                                         suggest: ''
 133                                                 } ).done( function ( data ) {
 134                                                         $el.suggestions( 'suggestions', data[1] );
 135                                                 } ) );
 136                                         }
 137                                 },
 138                                 cancel: function () {
 139                                         var apiPromise = $( this ).data( 'request' );
 140                                         // If the delay setting has caused the fetch to have not even happened
 141                                         // yet, the apiPromise object will have never been set.
 142                                         if ( apiPromise && $.isFunction( apiPromise.abort ) ) {
 143                                                 apiPromise.abort();
 144                                                 $( this ).removeData( 'request' );
 145                                         }
 146                                 },
 147                                 result: {
 148                                         render: renderFunction,
 149                                         select: function () {
 150                                                 return true; // allow the form to be submitted
 151                                         }
 152                                 },
 153                                 delay: 120,
 154                                 highlightInput: true
 155                         } )
 156                         .bind( 'paste cut drop', function () {
 157                                 // make sure paste and cut events from the mouse and drag&drop events
 158                                 // trigger the keypress handler and cause the suggestions to update
 159                                 $( this ).trigger( 'keypress' );
 160                         } )
 161                         // In most skins (at least Monobook and Vector), the font-size is messed up in <body>.
 162                         // (they use 2 elements to get a sane font-height). So, instead of making exceptions for
 163                         // each skin or adding more stylesheets, just copy it from the active element so auto-fit.
 164                         .each( function () {
 165                                 var $this = $( this );
 166                                 $this
 167                                         .data( 'suggestions-context' )
 168                                         .data.$container
 169                                                 .css( 'fontSize', $this.css( 'fontSize' ) );
 170                         } );
 171
 172                 // Ensure that the thing is actually present!
 173                 if ( $searchRegion.length === 0 ) {
 174                         // Don't try to set anything up if simpleSearch is disabled sitewide.
 175                         // The loader code loads us if the option is present, even if we're
 176                         // not actually enabled (anymore).
 177                         return;
 178                 }
 179
 180                 // Special suggestions functionality for skin-provided search box
 181                 $searchInput.suggestions( {
 182                         special: {
 183                                 render: specialRenderFunction,
 184                                 select: function ( $input ) {
 185                                         $input.closest( 'form' )
 186                                                 .append( $( '<input type="hidden" name="fulltext" value="1"/>' ) );
 187                                         return true; // allow the form to be submitted
 188                                 }
 189                         },
 190                         $region: $searchRegion
 191                 } );
 192
 193                 // If the form includes any fallback fulltext search buttons, remove them
 194                 $searchInput.closest( 'form' ).find( '.mw-fallbackSearchButton' ).remove();
 195         } );
 196
 197 }( mediaWiki, jQuery ) );