6031f991319e4a258c6aba6ad0512fd7b91fe5cb
5 * Sphinx JavaScript utilities for the full-text search.
7 * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
8 * :license: BSD, see LICENSE for details.
14 * Simple result scoring code.
17 // Implement the following function to further tweak the score for each result
18 // The function takes a result array [filename, title, anchor, descr, score]
19 // and returns the new score.
21 score: function(result) {
26 // query matches the full name of an object
28 // or matches in the last dotted part of the object name
30 // Additive scores depending on the priority of the object
31 objPrio
: {0: 15, // used to be importantResults
32 1: 5, // used to be objectResults
33 2: -5}, // used to be unimportantResults
34 // Used when the priority is not in the mapping.
37 // query found in title
40 // query found in terms
47 function splitQuery(query
) {
48 return query
.split(/\s+/);
61 htmlToText : function(htmlString
) {
62 var htmlElement
= document
.createElement('span');
63 htmlElement
.innerHTML
= htmlString
;
64 $(htmlElement
).find('.headerlink').remove();
65 docContent
= $(htmlElement
).find('[role=main]')[0];
66 return docContent
.textContent
|| docContent
.innerText
;
70 var params
= $.getQueryParameters();
72 var query
= params
.q
[0];
73 $('input[name="q"]')[0].value
= query
;
74 this.performSearch(query
);
78 loadIndex : function(url
) {
79 $.ajax({type
: "GET", url
: url
, data
: null,
80 dataType
: "script", cache
: true,
81 complete: function(jqxhr
, textstatus
) {
82 if (textstatus
!= "success") {
83 document
.getElementById("searchindexloader").src
= url
;
88 setIndex : function(index
) {
91 if ((q
= this._queued_query
) !== null) {
92 this._queued_query
= null;
97 hasIndex : function() {
98 return this._index
!== null;
101 deferQuery : function(query
) {
102 this._queued_query
= query
;
105 stopPulse : function() {
106 this._pulse_status
= 0;
109 startPulse : function() {
110 if (this._pulse_status
>= 0)
114 Search
._pulse_status
= (Search
._pulse_status
+ 1) % 4;
116 for (i
= 0; i
< Search
._pulse_status
; i
++)
118 Search
.dots
.text(dotString
);
119 if (Search
._pulse_status
> -1)
120 window
.setTimeout(pulse
, 500);
126 * perform a search for something (or wait until index is loaded)
128 performSearch : function(query
) {
129 // create the required interface elements
130 this.out
= $('#search-results');
131 this.title
= $('<h2>' + _('Searching') + '</h2>').appendTo(this.out
);
132 this.dots
= $('<span></span>').appendTo(this.title
);
133 this.status
= $('<p class="search-summary"> </p>').appendTo(this.out
);
134 this.output
= $('<ul class="search"/>').appendTo(this.out
);
136 $('#search-progress').text(_('Preparing search...'));
139 // index already loaded, the browser was quick!
143 this.deferQuery(query
);
147 * execute search (requires search index to be loaded)
149 query : function(query
) {
152 // stem the searchterms and add them to the correct list
153 var stemmer
= new Stemmer();
154 var searchterms
= [];
157 var tmp
= splitQuery(query
);
158 var objectterms
= [];
159 for (i
= 0; i
< tmp
.length
; i
++) {
161 objectterms
.push(tmp
[i
].toLowerCase());
164 if ($u
.indexOf(stopwords
, tmp
[i
].toLowerCase()) != -1 || tmp
[i
].match(/^\d+$/) ||
170 var word
= stemmer
.stemWord(tmp
[i
].toLowerCase());
171 // prevent stemmer from cutting word smaller than two chars
172 if(word
.length
< 3 && tmp
[i
].length
>= 3) {
176 // select the correct list
177 if (word
[0] == '-') {
179 word
= word
.substr(1);
182 toAppend
= searchterms
;
183 hlterms
.push(tmp
[i
].toLowerCase());
185 // only add if not already in the list
186 if (!$u
.contains(toAppend
, word
))
189 var highlightstring
= '?highlight=' + $.urlencode(hlterms
.join(" "));
191 // console.debug('SEARCH: searching for:');
192 // console.info('required: ', searchterms);
193 // console.info('excluded: ', excluded);
196 var terms
= this._index
.terms
;
197 var titleterms
= this._index
.titleterms
;
199 // array of [filename, title, anchor, descr, score]
201 $('#search-progress').empty();
204 for (i
= 0; i
< objectterms
.length
; i
++) {
205 var others
= [].concat(objectterms
.slice(0, i
),
206 objectterms
.slice(i
+1, objectterms
.length
));
207 results
= results
.concat(this.performObjectSearch(objectterms
[i
], others
));
210 // lookup as search terms in fulltext
211 results
= results
.concat(this.performTermsSearch(searchterms
, excluded
, terms
, titleterms
));
213 // let the scorer override scores with a custom scoring function
215 for (i
= 0; i
< results
.length
; i
++)
216 results
[i
][4] = Scorer
.score(results
[i
]);
219 // now sort the results by score (in opposite order of appearance, since the
220 // display function below uses pop() to retrieve items) and then
222 results
.sort(function(a
, b
) {
227 } else if (left
< right
) {
230 // same score: sort alphabetically
231 left
= a
[1].toLowerCase();
232 right
= b
[1].toLowerCase();
233 return (left
> right
) ? -1 : ((left
< right
) ? 1 : 0);
238 //Search.lastresults = results.slice(); // a copy
239 //console.info('search results:', Search.lastresults);
242 var resultCount
= results
.length
;
243 function displayNextItem() {
244 // results left, load the summary and display it
245 if (results
.length
) {
246 var item
= results
.pop();
247 var listItem
= $('<li style="display:none"></li>');
248 if (DOCUMENTATION_OPTIONS
.FILE_SUFFIX
=== '') {
250 var dirname
= item
[0] + '/';
251 if (dirname
.match(/\/index\/$/)) {
252 dirname
= dirname
.substring(0, dirname
.length
-6);
253 } else if (dirname
== 'index/') {
256 listItem
.append($('<a/>').attr('href',
257 DOCUMENTATION_OPTIONS
.URL_ROOT
+ dirname
+
258 highlightstring
+ item
[2]).html(item
[1]));
260 // normal html builders
261 listItem
.append($('<a/>').attr('href',
262 item
[0] + DOCUMENTATION_OPTIONS
.FILE_SUFFIX
+
263 highlightstring
+ item
[2]).html(item
[1]));
266 listItem
.append($('<span> (' + item
[3] + ')</span>'));
267 Search
.output
.append(listItem
);
268 listItem
.slideDown(5, function() {
271 } else if (DOCUMENTATION_OPTIONS
.HAS_SOURCE
) {
272 $.ajax({url
: DOCUMENTATION_OPTIONS
.URL_ROOT
+ item
[0] + DOCUMENTATION_OPTIONS
.FILE_SUFFIX
,
274 complete: function(jqxhr
, textstatus
) {
275 var data
= jqxhr
.responseText
;
276 if (data
!== '' && data
!== undefined) {
277 listItem
.append(Search
.makeSearchSummary(data
, searchterms
, hlterms
));
279 Search
.output
.append(listItem
);
280 listItem
.slideDown(5, function() {
285 // no source available, just display title
286 Search
.output
.append(listItem
);
287 listItem
.slideDown(5, function() {
292 // search finished, update title and status message
295 Search
.title
.text(_('Search Results'));
297 Search
.status
.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
299 Search
.status
.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount
));
300 Search
.status
.fadeIn(500);
307 * search for object names
309 performObjectSearch : function(object
, otherterms
) {
310 var filenames
= this._index
.filenames
;
311 var docnames
= this._index
.docnames
;
312 var objects
= this._index
.objects
;
313 var objnames
= this._index
.objnames
;
314 var titles
= this._index
.titles
;
319 for (var prefix
in objects
) {
320 for (var name
in objects
[prefix
]) {
321 var fullname
= (prefix
? prefix
+ '.' : '') + name
;
322 var fullnameLower
= fullname
.toLowerCase()
323 if (fullnameLower
.indexOf(object
) > -1) {
325 var parts
= fullnameLower
.split('.');
326 // check for different match types: exact matches of full name or
327 // "last name" (i.e. last dotted part)
328 if (fullnameLower
== object
|| parts
[parts
.length
- 1] == object
) {
329 score
+= Scorer
.objNameMatch
;
330 // matches in last name
331 } else if (parts
[parts
.length
- 1].indexOf(object
) > -1) {
332 score
+= Scorer
.objPartialMatch
;
334 var match
= objects
[prefix
][name
];
335 var objname
= objnames
[match
[1]][2];
336 var title
= titles
[match
[0]];
337 // If more than one term searched for, we require other words to be
338 // found in the name/title/description
339 if (otherterms
.length
> 0) {
340 var haystack
= (prefix
+ ' ' + name
+ ' ' +
341 objname
+ ' ' + title
).toLowerCase();
343 for (i
= 0; i
< otherterms
.length
; i
++) {
344 if (haystack
.indexOf(otherterms
[i
]) == -1) {
353 var descr
= objname
+ _(', in ') + title
;
355 var anchor
= match
[3];
358 else if (anchor
== '-')
359 anchor
= objnames
[match
[1]][1] + '-' + fullname
;
360 // add custom score for some objects according to scorer
361 if (Scorer
.objPrio
.hasOwnProperty(match
[2])) {
362 score
+= Scorer
.objPrio
[match
[2]];
364 score
+= Scorer
.objPrioDefault
;
366 results
.push([docnames
[match
[0]], fullname
, '#'+anchor
, descr
, score
, filenames
[match
[0]]]);
375 * search for full-text terms in the index
377 performTermsSearch : function(searchterms
, excluded
, terms
, titleterms
) {
378 var docnames
= this._index
.docnames
;
379 var filenames
= this._index
.filenames
;
380 var titles
= this._index
.titles
;
387 // perform the search on the required terms
388 for (i
= 0; i
< searchterms
.length
; i
++) {
389 var word
= searchterms
[i
];
392 {files
: terms
[word
], score
: Scorer
.term
},
393 {files
: titleterms
[word
], score
: Scorer
.title
}
395 // add support for partial matches
396 if (word
.length
> 2) {
397 for (var w
in terms
) {
398 if (w
.match(word
) && !terms
[word
]) {
399 _o
.push({files
: terms
[w
], score
: Scorer
.partialTerm
})
402 for (var w
in titleterms
) {
403 if (w
.match(word
) && !titleterms
[word
]) {
404 _o
.push({files
: titleterms
[w
], score
: Scorer
.partialTitle
})
409 // no match but word was a required one
410 if ($u
.every(_o
, function(o
){return o
.files
=== undefined;})) {
413 // found search word in contents
414 $u
.each(_o
, function(o
) {
415 var _files
= o
.files
;
416 if (_files
=== undefined)
419 if (_files
.length
=== undefined)
421 files
= files
.concat(_files
);
423 // set score for the word in each file to Scorer.term
424 for (j
= 0; j
< _files
.length
; j
++) {
426 if (!(file
in scoreMap
))
428 scoreMap
[file
][word
] = o
.score
;
432 // create the mapping
433 for (j
= 0; j
< files
.length
; j
++) {
436 fileMap
[file
].push(word
);
438 fileMap
[file
] = [word
];
442 // now check if the files don't contain excluded terms
443 for (file
in fileMap
) {
446 // check if all requirements are matched
447 var filteredTermCount
= // as search terms with length < 3 are discarded: ignore
448 searchterms
.filter(function(term
){return term
.length
> 2}).length
450 fileMap
[file
].length
!= searchterms
.length
&&
451 fileMap
[file
].length
!= filteredTermCount
454 // ensure that none of the excluded terms is in the search result
455 for (i
= 0; i
< excluded
.length
; i
++) {
456 if (terms
[excluded
[i
]] == file
||
457 titleterms
[excluded
[i
]] == file
||
458 $u
.contains(terms
[excluded
[i
]] || [], file
) ||
459 $u
.contains(titleterms
[excluded
[i
]] || [], file
)) {
465 // if we have still a valid result we can add it to the result list
467 // select one (max) score for the file.
468 // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
469 var score
= $u
.max($u
.map(fileMap
[file
], function(w
){return scoreMap
[file
][w
]}));
470 results
.push([docnames
[file
], titles
[file
], '', null, score
, filenames
[file
]]);
477 * helper function to return a node containing the
478 * search summary for a given text. keywords is a list
479 * of stemmed words, hlwords is the list of normal, unstemmed
480 * words. the first one is used to find the occurrence, the
481 * latter for highlighting it.
483 makeSearchSummary : function(htmlText
, keywords
, hlwords
) {
484 var text
= Search
.htmlToText(htmlText
);
485 var textLower
= text
.toLowerCase();
487 $.each(keywords
, function() {
488 var i
= textLower
.indexOf(this.toLowerCase());
492 start
= Math
.max(start
- 120, 0);
493 var excerpt
= ((start
> 0) ? '...' : '') +
494 $.trim(text
.substr(start
, 240)) +
495 ((start
+ 240 - text
.length
) ? '...' : '');
496 var rv
= $('<div class="context"></div>').text(excerpt
);
497 $.each(hlwords
, function() {
498 rv
= rv
.highlightText(this, 'highlighted');
504 $(document
).ready(function() {