2 * OpenSearch ajax suggestion engine for MediaWiki
4 * uses core MediaWiki open search support to fetch suggestions
5 * and show them below search boxes and other inputs
7 * by Robert Stojnic (April 2008)
10 // search_box_id -> Results object
12 // cached data, url -> json_text
14 // global variables for suggest_keypress
15 var os_cur_keypressed
= 0;
16 var os_last_keypress
= 0;
17 var os_keypressed_count
= 0;
20 // tie mousedown/up events
21 var os_mouse_pressed
= false;
22 var os_mouse_num
= -1;
23 // if true, the last change was made by mouse (and not keyboard)
24 var os_mouse_moved
= false;
25 // delay between keypress and suggestion (in ms)
26 var os_search_timeout
= 250;
27 // these pairs of inputs/forms will be autoloaded at startup
28 var os_autoload_inputs
= new Array('searchInput', 'powerSearchText', 'searchText');
29 var os_autoload_forms
= new Array('searchform', 'powersearch', 'search' );
30 // if we stopped the service
31 var os_is_stopped
= false;
32 // max lines to show in suggest table
33 var os_max_lines_per_suggest
= 7;
34 // if we are about to focus the searchbox for the first time
35 var os_first_focus
= true;
37 /** Timeout timer class that will fetch the results */
38 function os_Timer(id
,r
,query
){
44 /** Property class for single search box */
45 function os_Results(name
, formname
){
46 this.searchform
= formname
; // id of the searchform
47 this.searchbox
= name
; // id of the searchbox
48 this.container
= name
+"Suggest"; // div that holds results
49 this.resultTable
= name
+"Result"; // id base for the result table (+num = table row)
50 this.resultText
= name
+"ResultText"; // id base for the spans within result tables (+num)
51 this.toggle
= name
+"Toggle"; // div that has the toggle (enable/disable) link
52 this.query
= null; // last processed query
53 this.results
= null; // parsed titles
54 this.resultCount
= 0; // number of results
55 this.original
= null; // query that user entered
56 this.selected
= -1; // which result is selected
57 this.containerCount
= 0; // number of results visible in container
58 this.containerRow
= 0; // height of result field in the container
59 this.containerTotal
= 0; // total height of the container will all results
60 this.visible
= false; // if container is visible
63 /** Hide results div */
64 function os_hideResults(r
){
65 var c
= document
.getElementById(r
.container
);
67 c
.style
.visibility
= "hidden";
72 /** Show results div */
73 function os_showResults(r
){
77 var c
= document
.getElementById(r
.container
);
81 c
.style
.visibility
= "visible";
86 function os_operaWidthFix(x
){
87 // TODO: better css2 incompatibility detection here
88 if(is_opera
|| is_khtml
|| navigator
.userAgent
.toLowerCase().indexOf('firefox/1')!=-1){
89 return x
- 30; // opera&konqueror & old firefox don't understand overflow-x, estimate scrollbar width
94 function os_encodeQuery(value
){
95 if (encodeURIComponent
) {
96 return encodeURIComponent(value
);
102 function os_decodeValue(value
){
103 if (decodeURIComponent
) {
104 return decodeURIComponent(value
);
107 return unescape(value
);
111 /** Brower-dependent functions to find window inner size, and scroll status */
112 function f_clientWidth() {
113 return f_filterResults (
114 window
.innerWidth
? window
.innerWidth
: 0,
115 document
.documentElement
? document
.documentElement
.clientWidth
: 0,
116 document
.body
? document
.body
.clientWidth
: 0
119 function f_clientHeight() {
120 return f_filterResults (
121 window
.innerHeight
? window
.innerHeight
: 0,
122 document
.documentElement
? document
.documentElement
.clientHeight
: 0,
123 document
.body
? document
.body
.clientHeight
: 0
126 function f_scrollLeft() {
127 return f_filterResults (
128 window
.pageXOffset
? window
.pageXOffset
: 0,
129 document
.documentElement
? document
.documentElement
.scrollLeft
: 0,
130 document
.body
? document
.body
.scrollLeft
: 0
133 function f_scrollTop() {
134 return f_filterResults (
135 window
.pageYOffset
? window
.pageYOffset
: 0,
136 document
.documentElement
? document
.documentElement
.scrollTop
: 0,
137 document
.body
? document
.body
.scrollTop
: 0
140 function f_filterResults(n_win
, n_docel
, n_body
) {
141 var n_result
= n_win
? n_win
: 0;
142 if (n_docel
&& (!n_result
|| (n_result
> n_docel
)))
144 return n_body
&& (!n_result
|| (n_result
> n_body
)) ? n_body
: n_result
;
147 /** Get the height available for the results container */
148 function os_availableHeight(r
){
149 var absTop
= document
.getElementById(r
.container
).style
.top
;
150 var px
= absTop
.lastIndexOf("px");
152 absTop
= absTop
.substring(0,px
);
153 return f_clientHeight() - (absTop
- f_scrollTop());
157 /** Get element absolute position {left,top} */
158 function os_getElementPosition(elemID
){
159 var offsetTrail
= document
.getElementById(elemID
);
163 offsetLeft
+= offsetTrail
.offsetLeft
;
164 offsetTop
+= offsetTrail
.offsetTop
;
165 offsetTrail
= offsetTrail
.offsetParent
;
167 if (navigator
.userAgent
.indexOf('Mac') != -1 && typeof document
.body
.leftMargin
!= 'undefined'){
168 offsetLeft
+= document
.body
.leftMargin
;
169 offsetTop
+= document
.body
.topMargin
;
171 return {left
:offsetLeft
,top
:offsetTop
};
174 /** Create the container div that will hold the suggested titles */
175 function os_createContainer(r
){
176 var c
= document
.createElement("div");
177 var s
= document
.getElementById(r
.searchbox
);
178 var pos
= os_getElementPosition(r
.searchbox
);
180 var top
= pos
.top
+ s
.offsetHeight
;
181 var body
= document
.getElementById("globalWrapper");
182 c
.className
= "os-suggest";
183 c
.setAttribute("id", r
.container
);
186 // dynamically generated style params
187 // IE workaround, cannot explicitely set "style" attribute
188 c
= document
.getElementById(r
.container
);
189 c
.style
.top
= top
+"px";
190 c
.style
.left
= left
+"px";
191 c
.style
.width
= s
.offsetWidth
+"px";
193 // mouse event handlers
194 c
.onmouseover = function(event
) { os_eventMouseover(r
.searchbox
, event
); };
195 c
.onmousemove = function(event
) { os_eventMousemove(r
.searchbox
, event
); };
196 c
.onmousedown = function(event
) { return os_eventMousedown(r
.searchbox
, event
); };
197 c
.onmouseup = function(event
) { os_eventMouseup(r
.searchbox
, event
); };
201 /** change container height to fit to screen */
202 function os_fitContainer(r
){
203 var c
= document
.getElementById(r
.container
);
204 var h
= os_availableHeight(r
) - 20;
205 var inc
= r
.containerRow
;
206 h
= parseInt(h
/inc
) * inc
;
207 if(h
< (2 * inc
) && r
.resultCount
> 1) // min: two results
209 if((h
/inc
) > os_max_lines_per_suggest
)
210 h
= inc
* os_max_lines_per_suggest
;
211 if(h
< r
.containerTotal
){
212 c
.style
.height
= h
+"px";
213 r
.containerCount
= parseInt(Math
.round(h
/inc
));
215 c
.style
.height
= r
.containerTotal
+"px";
216 r
.containerCount
= r
.resultCount
;
219 /** If some entries are longer than the box, replace text with "..." */
220 function os_trimResultText(r
){
221 var w
= document
.getElementById(r
.container
).offsetWidth
;
222 if(r
.containerCount
< r
.resultCount
){
223 w
-= 20; // give 20px for scrollbar
225 w
= os_operaWidthFix(w
);
228 for(var i
=0;i
<r
.resultCount
;i
++){
229 var e
= document
.getElementById(r
.resultText
+i
);
231 var lastW
= e
.offsetWidth
+1;
233 var changedText
= false;
234 while(e
.offsetWidth
> w
&& (e
.offsetWidth
< lastW
|| iteration
<2)){
236 lastW
= e
.offsetWidth
;
238 e
.innerHTML
= l
.substring(0,l
.length
-replace
)+"...";
240 replace
= 4; // how many chars to replace
243 // show hint for trimmed titles
244 document
.getElementById(r
.resultTable
+i
).setAttribute("title",r
.results
[i
]);
249 /** Handles data from XMLHttpRequest, and updates the suggest results */
250 function os_updateResults(r
, query
, text
, cacheKey
){
251 os_cache
[cacheKey
] = text
;
260 var p
= eval('('+text
+')'); // simple json parse, could do a safer one
261 if(p
.length
<2 || p
[1].length
== 0){
267 var c
= document
.getElementById(r
.container
);
269 c
= os_createContainer(r
);
270 c
.innerHTML
= os_createResultTable(r
,p
[1]);
271 // init container table sizes
272 var t
= document
.getElementById(r
.resultTable
);
273 r
.containerTotal
= t
.offsetHeight
;
274 r
.containerRow
= t
.offsetHeight
/ r
.resultCount
;
275 os_trimResultText(r
);
278 // bad response from server or such
280 os_cache
[cacheKey
] = null;
285 /** Create the result table to be placed in the container div */
286 function os_createResultTable(r
, results
){
287 var c
= document
.getElementById(r
.container
);
288 var width
= os_operaWidthFix(c
.offsetWidth
);
289 var html
= "<table class=\"os-suggest-results\" id=\""+r
.resultTable
+"\" style=\"width: "+width
+"px;\">";
290 r
.results
= new Array();
291 r
.resultCount
= results
.length
;
292 for(i
=0;i
<results
.length
;i
++){
293 var title
= os_decodeValue(results
[i
]);
294 r
.results
[i
] = title
;
295 html
+= "<tr><td class=\"os-suggest-result\" id=\""+r
.resultTable
+i
+"\"><span id=\""+r
.resultText
+i
+"\">"+title
+"</span></td></tr>";
301 /** Fetch namespaces from checkboxes or hidden fields in the search form,
302 if none defined use wgSearchNamespaces global */
303 function os_getNamespaces(r
){
305 var elements
= document
.forms
[r
.searchform
].elements
;
306 for(i
=0; i
< elements
.length
; i
++){
307 var name
= elements
[i
].name
;
308 if(typeof name
!= 'undefined' && name
.length
> 2
309 && name
[0]=='n' && name
[1]=='s'
310 && ((elements
[i
].type
=='checkbox' && elements
[i
].checked
)
311 || (elements
[i
].type
=='hidden' && elements
[i
].value
=="1")) ){
314 namespaces
+=name
.substring(2);
318 namespaces
= wgSearchNamespaces
.join("|");
322 /** Update results if user hasn't already typed something else */
323 function os_updateIfRelevant(r
, query
, text
, cacheKey
){
324 var t
= document
.getElementById(r
.searchbox
);
325 if(t
!= null && t
.value
== query
){ // check if response is still relevant
326 os_updateResults(r
, query
, text
, cacheKey
);
331 /** Fetch results after some timeout */
332 function os_delayedFetch(){
336 var query
= os_timer
.query
;
338 var path
= wgMWSuggestTemplate
.replace("{namespaces}",os_getNamespaces(r
))
339 .replace("{dbname}",wgDBname
)
340 .replace("{searchTerms}",os_encodeQuery(query
));
342 // try to get from cache, if not fetch using ajax
343 var cached
= os_cache
[path
];
345 os_updateIfRelevant(r
, query
, cached
, path
);
347 var xmlhttp
= sajax_init_object();
350 xmlhttp
.open("GET", path
, true);
351 xmlhttp
.onreadystatechange=function(){
352 if (xmlhttp
.readyState
==4 && typeof os_updateIfRelevant
== 'function') {
353 os_updateIfRelevant(r
, query
, xmlhttp
.responseText
, path
);
358 if (window
.location
.hostname
== "localhost") {
359 alert("Your browser blocks XMLHttpRequest to 'localhost', try using a real hostname for development/testing.");
367 /** Init timed update via os_delayedUpdate() */
368 function os_fetchResults(r
, query
, timeout
){
372 } else if(query
== r
.query
)
375 os_is_stopped
= false; // make sure we're running
377 /* var cacheKey = wgDBname+":"+query;
378 var cached = os_cache[cacheKey];
380 os_updateResults(r,wgDBname,query,cached);
384 // cancel any pending fetches
385 if(os_timer
!= null && os_timer
.id
!= null)
386 clearTimeout(os_timer
.id
);
387 // schedule delayed fetching of results
389 os_timer
= new os_Timer(setTimeout("os_delayedFetch()",timeout
),r
,query
);
391 os_timer
= new os_Timer(null,r
,query
);
392 os_delayedFetch(); // do it now!
396 /** Change the highlighted row (i.e. suggestion), from position cur to next */
397 function os_changeHighlight(r
, cur
, next
, updateSearchBox
){
398 if (next
>= r
.resultCount
)
399 next
= r
.resultCount
-1;
404 return; // nothing to do.
407 var curRow
= document
.getElementById(r
.resultTable
+ cur
);
409 curRow
.className
= "os-suggest-result";
413 var nextRow
= document
.getElementById(r
.resultTable
+ next
);
415 nextRow
.className
= "os-suggest-result-hl";
416 newText
= r
.results
[next
];
418 newText
= r
.original
;
420 // adjust the scrollbar if any
421 if(r
.containerCount
< r
.resultCount
){
422 var c
= document
.getElementById(r
.container
);
423 var vStart
= c
.scrollTop
/ r
.containerRow
;
424 var vEnd
= vStart
+ r
.containerCount
;
426 c
.scrollTop
= next
* r
.containerRow
;
427 else if(next
>= vEnd
)
428 c
.scrollTop
= (next
- r
.containerCount
+ 1) * r
.containerRow
;
431 // update the contents of the search box
433 os_updateSearchQuery(r
,newText
);
437 function os_updateSearchQuery(r
,newText
){
438 document
.getElementById(r
.searchbox
).value
= newText
;
442 /** Find event target */
443 function os_getTarget(e
){
444 if (!e
) var e
= window
.event
;
445 if (e
.target
) return e
.target
;
446 else if (e
.srcElement
) return e
.srcElement
;
452 /********************
454 ********************/
456 /** Event handler that will fetch results on keyup */
457 function os_eventKeyup(e
){
458 var targ
= os_getTarget(e
);
459 var r
= os_map
[targ
.id
];
461 return; // not our event
463 // some browsers won't generate keypressed for arrow keys, catch it
464 if(os_keypressed_count
== 0){
465 os_processKey(r
,os_cur_keypressed
,targ
);
467 var query
= targ
.value
;
468 os_fetchResults(r
,query
,os_search_timeout
);
471 /** catch arrows up/down and escape to hide the suggestions */
472 function os_processKey(r,keypressed,targ){
473 if (keypressed == 40){ // Arrow Down
475 os_changeHighlight(r, r.selected, r.selected+1, true);
476 } else if(os_timer == null){
477 // user wants to get suggestions now
479 os_fetchResults(r,targ.value,0);
481 } else if (keypressed == 38){ // Arrow Up
483 os_changeHighlight(r, r.selected, r.selected-1, true);
485 } else if(keypressed == 27){ // Escape
486 document.getElementById(r.searchbox).value = r.original;
487 r.query = r.original;
489 } else if(r.query != document.getElementById(r.searchbox).value){
490 // os_hideResults(r); // don't show old suggestions
494 /** When keys is held down use a timer to output regular events */
495 function os_eventKeypress(e
){
496 var targ
= os_getTarget(e
);
497 var r
= os_map
[targ
.id
];
499 return; // not our event
501 var keypressed
= os_cur_keypressed
;
502 if(keypressed
== 38 || keypressed
== 40){
504 var now
= d
.getTime();
505 if(now
- os_last_keypress
< 120){
506 os_last_keypress
= now
;
511 os_keypressed_count
++;
512 os_processKey(r
,keypressed
,targ
);
515 /** Catch the key code (Firefox bug) */
516 function os_eventKeydown(e
){
517 if (!e
) var e
= window
.event
;
518 if (e
.target
) targ
= e
.target
;
519 else if (e
.srcElement
) targ
= e
.srcElement
;
520 var r
= os_map
[targ
.id
];
522 return; // not our event
524 os_mouse_moved
= false;
527 // firefox bug, focus&defocus to make autocomplete=off valid
528 targ
.blur(); targ
.focus();
529 os_first_focus
= false;
532 os_cur_keypressed
= (window
.Event
) ? e
.which
: e
.keyCode
;
533 os_last_keypress
= 0;
534 os_keypressed_count
= 0;
537 /** Event: loss of focus of input box */
538 function os_eventBlur(e
){
540 return; // we are focusing/defocusing
541 var targ
= os_getTarget(e
);
542 var r
= os_map
[targ
.id
];
544 return; // not our event
545 if(!os_mouse_pressed
)
549 /** Event: focus (catch only when stopped) */
550 function os_eventFocus(e
){
552 return; // we are focusing/defocusing
557 /********************
559 ********************/
561 /** Mouse over the container */
562 function os_eventMouseover(srcId
, e
){
563 var targ
= os_getTarget(e
);
564 var r
= os_map
[srcId
];
565 if(r
== null || !os_mouse_moved
)
566 return; // not our event
567 var num
= os_getNumberSuffix(targ
.id
);
569 os_changeHighlight(r
,r
.selected
,num
,false);
573 /* Get row where the event occured (from its id) */
574 function os_getNumberSuffix(id
){
575 var num
= id
.substring(id
.length
-2);
576 if( ! (num
.charAt(0) >= '0' && num
.charAt(0) <= '9') )
577 num
= num
.substring(1);
579 return parseInt(num
);
584 /** Save mouse move as last action */
585 function os_eventMousemove(srcId
, e
){
586 os_mouse_moved
= true;
589 /** Mouse button held down, register possible click */
590 function os_eventMousedown(srcId
, e
){
591 var targ
= os_getTarget(e
);
592 var r
= os_map
[srcId
];
594 return; // not our event
595 var num
= os_getNumberSuffix(targ
.id
);
597 os_mouse_pressed
= true;
600 // os_updateSearchQuery(r,r.results[num]);
602 // keep the focus on the search field
603 document
.getElementById(r
.searchbox
).focus();
605 return false; // prevents selection
608 /** Mouse button released, check for click on some row */
609 function os_eventMouseup(srcId
, e
){
610 var targ
= os_getTarget(e
);
611 var r
= os_map
[srcId
];
613 return; // not our event
614 var num
= os_getNumberSuffix(targ
.id
);
616 if(num
>= 0 && os_mouse_num
== num
){
617 os_updateSearchQuery(r
,r
.results
[num
]);
619 document
.getElementById(r
.searchform
).submit();
621 os_mouse_pressed
= false;
622 // keep the focus on the search field
623 document
.getElementById(r
.searchbox
).focus();
626 /** Check if x is a valid integer */
627 function os_isNumber(x
){
628 if(x
== "" || isNaN(x
))
630 for(var i
=0;i
<x
.length
;i
++){
632 if( ! (c
>= '0' && c
<= '9') )
639 /** When the form is submitted hide everything, cancel updates... */
640 function os_eventOnsubmit(e
){
641 var targ
= os_getTarget(e
);
643 os_is_stopped
= true;
644 // kill timed requests
645 if(os_timer
!= null && os_timer
.id
!= null){
646 clearTimeout(os_timer
.id
);
649 // Hide all suggestions
650 for(i
=0;i
<os_autoload_inputs
.length
;i
++){
651 var r
= os_map
[os_autoload_inputs
[i
]];
653 var b
= document
.getElementById(r
.searchform
);
654 if(b
!= null && b
== targ
){
655 // set query value so the handler won't try to fetch additional results
656 r
.query
= document
.getElementById(r
.searchbox
).value
;
664 /** Init Result objects and event handlers */
665 function os_initHandlers(name
, formname
, element
){
666 var r
= new os_Results(name
, formname
);
668 element
.onkeyup = function(event
) { os_eventKeyup(event
); };
669 element
.onkeydown = function(event
) { os_eventKeydown(event
); };
670 element
.onkeypress = function(event
) { os_eventKeypress(event
); };
671 element
.onblur = function(event
) { os_eventBlur(event
); };
672 element
.onfocus = function(event
) { os_eventFocus(event
); };
673 element
.setAttribute("autocomplete","off");
675 document
.getElementById(formname
).onsubmit = function(event
){ return os_eventOnsubmit(event
); };
678 if(document
.getElementById(r
.toggle
) == null){
679 // TODO: disable this while we figure out a way for this to work in all browsers
680 /* if(name=='searchInput'){
681 // special case: place above the main search box
682 var t = os_createToggle(r,"os-suggest-toggle");
683 var searchBody = document.getElementById('searchBody');
684 var first = searchBody.parentNode.firstChild.nextSibling.appendChild(t);
686 // default: place below search box to the right
687 var t = os_createToggle(r,"os-suggest-toggle-def");
688 var top = element.offsetTop + element.offsetHeight;
689 var left = element.offsetLeft + element.offsetWidth;
690 t.style.position = "absolute";
691 t.style.top = top + "px";
692 t.style.left = left + "px";
693 element.parentNode.appendChild(t);
694 // only now width gets calculated, shift right
695 left -= t.offsetWidth;
696 t.style.left = left + "px";
697 t.style.visibility = "visible";
703 /** Return the span element that contains the toggle link */
704 function os_createToggle(r
,className
){
705 var t
= document
.createElement("span");
706 t
.className
= className
;
707 t
.setAttribute("id", r
.toggle
);
708 var link
= document
.createElement("a");
709 link
.setAttribute("href","javascript:void(0);");
710 link
.onclick = function(){ os_toggle(r
.searchbox
,r
.searchform
) };
711 var msg
= document
.createTextNode(wgMWSuggestMessages
[0]);
712 link
.appendChild(msg
);
717 /** Call when user clicks on some of the toggle links */
718 function os_toggle(inputId
,formName
){
722 os_enableSuggestionsOn(inputId
,formName
);
724 msg
= wgMWSuggestMessages
[0];
726 os_disableSuggestionsOn(inputId
,formName
);
727 msg
= wgMWSuggestMessages
[1];
730 var link
= document
.getElementById(r
.toggle
).firstChild
;
731 link
.replaceChild(document
.createTextNode(msg
),link
.firstChild
);
734 /** Call this to enable suggestions on input (id=inputId), on a form (name=formName) */
735 function os_enableSuggestionsOn(inputId
, formName
){
736 os_initHandlers( inputId
, formName
, document
.getElementById(inputId
) );
739 /** Call this to disable suggestios on input box (id=inputId) */
740 function os_disableSuggestionsOn(inputId
){
743 // cancel/hide results
746 // turn autocomplete on !
747 document
.getElementById(inputId
).setAttribute("autocomplete","on");
749 os_map
[inputId
] = null;
753 /** Initialization, call upon page onload */
754 function os_MWSuggestInit() {
755 for(i
=0;i
<os_autoload_inputs
.length
;i
++){
756 var id
= os_autoload_inputs
[i
];
757 var form
= os_autoload_forms
[i
];
758 element
= document
.getElementById( id
);
760 os_initHandlers(id
,form
,element
);
764 hookEvent("load", os_MWSuggestInit
);