ab56499655111429619df63a1dc6687646d22a3e
5 * Sphinx JavaScript utilities for the full-text search.
7 * :copyright: Copyright 2007-2020 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 if(docContent
=== undefined) {
67 console
.warn("Content block not found. Sphinx search tries to obtain it " +
68 "via '[role=main]'. Could you check your theme or template.");
71 return docContent
.textContent
|| docContent
.innerText
;
75 var params
= $.getQueryParameters();
77 var query
= params
.q
[0];
78 $('input[name="q"]')[0].value
= query
;
79 this.performSearch(query
);
83 loadIndex : function(url
) {
84 $.ajax({type
: "GET", url
: url
, data
: null,
85 dataType
: "script", cache
: true,
86 complete: function(jqxhr
, textstatus
) {
87 if (textstatus
!= "success") {
88 document
.getElementById("searchindexloader").src
= url
;
93 setIndex : function(index
) {
96 if ((q
= this._queued_query
) !== null) {
97 this._queued_query
= null;
102 hasIndex : function() {
103 return this._index
!== null;
106 deferQuery : function(query
) {
107 this._queued_query
= query
;
110 stopPulse : function() {
111 this._pulse_status
= 0;
114 startPulse : function() {
115 if (this._pulse_status
>= 0)
119 Search
._pulse_status
= (Search
._pulse_status
+ 1) % 4;
121 for (i
= 0; i
< Search
._pulse_status
; i
++)
123 Search
.dots
.text(dotString
);
124 if (Search
._pulse_status
> -1)
125 window
.setTimeout(pulse
, 500);
131 * perform a search for something (or wait until index is loaded)
133 performSearch : function(query
) {
134 // create the required interface elements
135 this.out
= $('#search-results');
136 this.title
= $('<h2>' + _('Searching') + '</h2>').appendTo(this.out
);
137 this.dots
= $('<span></span>').appendTo(this.title
);
138 this.status
= $('<p class="search-summary"> </p>').appendTo(this.out
);
139 this.output
= $('<ul class="search"/>').appendTo(this.out
);
141 $('#search-progress').text(_('Preparing search...'));
144 // index already loaded, the browser was quick!
148 this.deferQuery(query
);
152 * execute search (requires search index to be loaded)
154 query : function(query
) {
157 // stem the searchterms and add them to the correct list
158 var stemmer
= new Stemmer();
159 var searchterms
= [];
162 var tmp
= splitQuery(query
);
163 var objectterms
= [];
164 for (i
= 0; i
< tmp
.length
; i
++) {
166 objectterms
.push(tmp
[i
].toLowerCase());
169 if ($u
.indexOf(stopwords
, tmp
[i
].toLowerCase()) != -1 || tmp
[i
].match(/^\d+$/) ||
175 var word
= stemmer
.stemWord(tmp
[i
].toLowerCase());
176 // prevent stemmer from cutting word smaller than two chars
177 if(word
.length
< 3 && tmp
[i
].length
>= 3) {
181 // select the correct list
182 if (word
[0] == '-') {
184 word
= word
.substr(1);
187 toAppend
= searchterms
;
188 hlterms
.push(tmp
[i
].toLowerCase());
190 // only add if not already in the list
191 if (!$u
.contains(toAppend
, word
))
194 var highlightstring
= '?highlight=' + $.urlencode(hlterms
.join(" "));
196 // console.debug('SEARCH: searching for:');
197 // console.info('required: ', searchterms);
198 // console.info('excluded: ', excluded);
201 var terms
= this._index
.terms
;
202 var titleterms
= this._index
.titleterms
;
204 // array of [filename, title, anchor, descr, score]
206 $('#search-progress').empty();
209 for (i
= 0; i
< objectterms
.length
; i
++) {
210 var others
= [].concat(objectterms
.slice(0, i
),
211 objectterms
.slice(i
+1, objectterms
.length
));
212 results
= results
.concat(this.performObjectSearch(objectterms
[i
], others
));
215 // lookup as search terms in fulltext
216 results
= results
.concat(this.performTermsSearch(searchterms
, excluded
, terms
, titleterms
));
218 // let the scorer override scores with a custom scoring function
220 for (i
= 0; i
< results
.length
; i
++)
221 results
[i
][4] = Scorer
.score(results
[i
]);
224 // now sort the results by score (in opposite order of appearance, since the
225 // display function below uses pop() to retrieve items) and then
227 results
.sort(function(a
, b
) {
232 } else if (left
< right
) {
235 // same score: sort alphabetically
236 left
= a
[1].toLowerCase();
237 right
= b
[1].toLowerCase();
238 return (left
> right
) ? -1 : ((left
< right
) ? 1 : 0);
243 //Search.lastresults = results.slice(); // a copy
244 //console.info('search results:', Search.lastresults);
247 var resultCount
= results
.length
;
248 function displayNextItem() {
249 // results left, load the summary and display it
250 if (results
.length
) {
251 var item
= results
.pop();
252 var listItem
= $('<li style="display:none"></li>');
255 if (DOCUMENTATION_OPTIONS
.BUILDER
=== 'dirhtml') {
257 var dirname
= item
[0] + '/';
258 if (dirname
.match(/\/index\/$/)) {
259 dirname
= dirname
.substring(0, dirname
.length
-6);
260 } else if (dirname
== 'index/') {
263 requestUrl
= DOCUMENTATION_OPTIONS
.URL_ROOT
+ dirname
;
264 linkUrl
= requestUrl
;
267 // normal html builders
268 requestUrl
= DOCUMENTATION_OPTIONS
.URL_ROOT
+ item
[0] + DOCUMENTATION_OPTIONS
.FILE_SUFFIX
;
269 linkUrl
= item
[0] + DOCUMENTATION_OPTIONS
.LINK_SUFFIX
;
271 listItem
.append($('<a/>').attr('href',
273 highlightstring
+ item
[2]).html(item
[1]));
275 listItem
.append($('<span> (' + item
[3] + ')</span>'));
276 Search
.output
.append(listItem
);
277 listItem
.slideDown(5, function() {
280 } else if (DOCUMENTATION_OPTIONS
.HAS_SOURCE
) {
281 $.ajax({url
: requestUrl
,
283 complete: function(jqxhr
, textstatus
) {
284 var data
= jqxhr
.responseText
;
285 if (data
!== '' && data
!== undefined) {
286 listItem
.append(Search
.makeSearchSummary(data
, searchterms
, hlterms
));
288 Search
.output
.append(listItem
);
289 listItem
.slideDown(5, function() {
294 // no source available, just display title
295 Search
.output
.append(listItem
);
296 listItem
.slideDown(5, function() {
301 // search finished, update title and status message
304 Search
.title
.text(_('Search Results'));
306 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.'));
308 Search
.status
.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount
));
309 Search
.status
.fadeIn(500);
316 * search for object names
318 performObjectSearch : function(object
, otherterms
) {
319 var filenames
= this._index
.filenames
;
320 var docnames
= this._index
.docnames
;
321 var objects
= this._index
.objects
;
322 var objnames
= this._index
.objnames
;
323 var titles
= this._index
.titles
;
328 for (var prefix
in objects
) {
329 for (var name
in objects
[prefix
]) {
330 var fullname
= (prefix
? prefix
+ '.' : '') + name
;
331 var fullnameLower
= fullname
.toLowerCase()
332 if (fullnameLower
.indexOf(object
) > -1) {
334 var parts
= fullnameLower
.split('.');
335 // check for different match types: exact matches of full name or
336 // "last name" (i.e. last dotted part)
337 if (fullnameLower
== object
|| parts
[parts
.length
- 1] == object
) {
338 score
+= Scorer
.objNameMatch
;
339 // matches in last name
340 } else if (parts
[parts
.length
- 1].indexOf(object
) > -1) {
341 score
+= Scorer
.objPartialMatch
;
343 var match
= objects
[prefix
][name
];
344 var objname
= objnames
[match
[1]][2];
345 var title
= titles
[match
[0]];
346 // If more than one term searched for, we require other words to be
347 // found in the name/title/description
348 if (otherterms
.length
> 0) {
349 var haystack
= (prefix
+ ' ' + name
+ ' ' +
350 objname
+ ' ' + title
).toLowerCase();
352 for (i
= 0; i
< otherterms
.length
; i
++) {
353 if (haystack
.indexOf(otherterms
[i
]) == -1) {
362 var descr
= objname
+ _(', in ') + title
;
364 var anchor
= match
[3];
367 else if (anchor
== '-')
368 anchor
= objnames
[match
[1]][1] + '-' + fullname
;
369 // add custom score for some objects according to scorer
370 if (Scorer
.objPrio
.hasOwnProperty(match
[2])) {
371 score
+= Scorer
.objPrio
[match
[2]];
373 score
+= Scorer
.objPrioDefault
;
375 results
.push([docnames
[match
[0]], fullname
, '#'+anchor
, descr
, score
, filenames
[match
[0]]]);
384 * search for full-text terms in the index
386 performTermsSearch : function(searchterms
, excluded
, terms
, titleterms
) {
387 var docnames
= this._index
.docnames
;
388 var filenames
= this._index
.filenames
;
389 var titles
= this._index
.titles
;
396 // perform the search on the required terms
397 for (i
= 0; i
< searchterms
.length
; i
++) {
398 var word
= searchterms
[i
];
401 {files
: terms
[word
], score
: Scorer
.term
},
402 {files
: titleterms
[word
], score
: Scorer
.title
}
404 // add support for partial matches
405 if (word
.length
> 2) {
406 for (var w
in terms
) {
407 if (w
.match(word
) && !terms
[word
]) {
408 _o
.push({files
: terms
[w
], score
: Scorer
.partialTerm
})
411 for (var w
in titleterms
) {
412 if (w
.match(word
) && !titleterms
[word
]) {
413 _o
.push({files
: titleterms
[w
], score
: Scorer
.partialTitle
})
418 // no match but word was a required one
419 if ($u
.every(_o
, function(o
){return o
.files
=== undefined;})) {
422 // found search word in contents
423 $u
.each(_o
, function(o
) {
424 var _files
= o
.files
;
425 if (_files
=== undefined)
428 if (_files
.length
=== undefined)
430 files
= files
.concat(_files
);
432 // set score for the word in each file to Scorer.term
433 for (j
= 0; j
< _files
.length
; j
++) {
435 if (!(file
in scoreMap
))
437 scoreMap
[file
][word
] = o
.score
;
441 // create the mapping
442 for (j
= 0; j
< files
.length
; j
++) {
444 if (file
in fileMap
&& fileMap
[file
].indexOf(word
) === -1)
445 fileMap
[file
].push(word
);
447 fileMap
[file
] = [word
];
451 // now check if the files don't contain excluded terms
452 for (file
in fileMap
) {
455 // check if all requirements are matched
456 var filteredTermCount
= // as search terms with length < 3 are discarded: ignore
457 searchterms
.filter(function(term
){return term
.length
> 2}).length
459 fileMap
[file
].length
!= searchterms
.length
&&
460 fileMap
[file
].length
!= filteredTermCount
463 // ensure that none of the excluded terms is in the search result
464 for (i
= 0; i
< excluded
.length
; i
++) {
465 if (terms
[excluded
[i
]] == file
||
466 titleterms
[excluded
[i
]] == file
||
467 $u
.contains(terms
[excluded
[i
]] || [], file
) ||
468 $u
.contains(titleterms
[excluded
[i
]] || [], file
)) {
474 // if we have still a valid result we can add it to the result list
476 // select one (max) score for the file.
477 // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
478 var score
= $u
.max($u
.map(fileMap
[file
], function(w
){return scoreMap
[file
][w
]}));
479 results
.push([docnames
[file
], titles
[file
], '', null, score
, filenames
[file
]]);
486 * helper function to return a node containing the
487 * search summary for a given text. keywords is a list
488 * of stemmed words, hlwords is the list of normal, unstemmed
489 * words. the first one is used to find the occurrence, the
490 * latter for highlighting it.
492 makeSearchSummary : function(htmlText
, keywords
, hlwords
) {
493 var text
= Search
.htmlToText(htmlText
);
494 var textLower
= text
.toLowerCase();
496 $.each(keywords
, function() {
497 var i
= textLower
.indexOf(this.toLowerCase());
501 start
= Math
.max(start
- 120, 0);
502 var excerpt
= ((start
> 0) ? '...' : '') +
503 $.trim(text
.substr(start
, 240)) +
504 ((start
+ 240 - text
.length
) ? '...' : '');
505 var rv
= $('<div class="context"></div>').text(excerpt
);
506 $.each(hlwords
, function() {
507 rv
= rv
.highlightText(this, 'highlighted');
513 $(document
).ready(function() {