Added frequency count for facets to demo app
[pazpar2-moved-to-github.git] / www / demo / search.js
1 /* $Id: search.js,v 1.25 2007-01-15 22:05:37 quinn Exp $
2  * ---------------------------------------------------
3  * Javascript container
4  */
5
6 var xmlHttp
7 var xinitSession;
8 var xloadTargets;
9 var xsearch;
10 var xshow;
11 var xstat;
12 var xtermlist;
13 var session = false;
14 var targetsloaded = false;
15 var shown;
16 var searchtimer;
17 var showtimer;
18 var termtimer;
19 var stattimer;
20 var session_cells = Array('query', 'startrec', 'action_type');
21 var old_session = session_read();
22 var url_surveillence;
23 var recstoshow = 20;
24 var page_window = 5;  // Number of pages prior to and after the current page
25 var facet_list;
26 var cur_facet = 0;
27 var cur_sort = "relevance";
28 var searched = 0;
29
30 function initialize ()
31 {
32     facet_list = get_available_facets();
33     start_session();
34     session_check();
35     set_sort();
36 }
37
38
39 function GetXmlHttpObject()
40
41     var objXMLHttp=null
42     if (window.XMLHttpRequest)
43       {
44       objXMLHttp=new XMLHttpRequest()
45       }
46     else if (window.ActiveXObject)
47       {
48       objXMLHttp=new ActiveXObject("Microsoft.XMLHTTP")
49       }
50     return objXMLHttp
51
52
53 function SendXmlHttpObject(obj, url, handler)
54 {
55     obj.onreadystatechange=handler;
56     obj.open("GET", url);
57     obj.send(null);
58 }
59
60 function session_started()
61 {
62     if (xinitSession.readyState != 4)
63         return;
64     var xml = xinitSession.responseXML;
65     var sesid = xml.getElementsByTagName("session")[0].childNodes[0].nodeValue;
66     assign_text(document.getElementById("status"), 'Live');
67     session = sesid;
68     setTimeout(ping_session, 50000);
69 }
70
71 function start_session()
72 {
73     xinitSession = GetXmlHttpObject();
74     var url="search.pz2?";
75     url += "command=init";
76     xinitSession.onreadystatechange=session_started;
77     xinitSession.open("GET", url);
78     xinitSession.send(null);
79 }
80
81 function ping_session()
82 {
83     if (!session)
84         return;
85     var url = "search.pz2?command=ping&session=" + session;
86     SendXmlHttpObject(xpingSession = GetXmlHttpObject(), url, session_pinged);
87 }
88
89 function session_pinged()
90 {
91     if (xpingSession.readyState != 4)
92         return;
93     var xml = xpingSession.responseXML;
94     var error = xml.getElementsByTagName("error");
95     if (error[0])
96     {
97         var msg = error[0].childNodes[0].nodeValue;
98         alert(msg);
99         location = "?";
100         return;
101     }
102     setTimeout(ping_session, 50000);
103 }
104
105 function update_action (new_action) {
106     document.search.action_type.value = new_action;
107 }
108
109
110 function make_pager (hits, offset, max) {
111     var html = '';
112     var off;
113     var start_offset = offset - page_window * max;
114     var div_elem = document.createElement('div');
115     
116     div_elem.className = 'pages';
117
118     if (start_offset < 0) {
119         start_offset = 0;
120     }
121
122     for (off = start_offset;
123          off < hits && off < (start_offset + 2 * page_window * max); 
124          off += max) {
125         
126         var p = off / max + 1;
127         var page_elem = create_element('a', p);
128         var newline_node = document.createTextNode(' ');
129
130         if ((offset >= off) && (offset < (off + max))) {
131             page_elem.className = 'select';
132         }
133
134         page_elem.setAttribute('off', off);
135         page_elem.style.cursor = 'pointer';
136         page_elem.onclick = function () {
137             update_offset(this.getAttribute('off'));
138         };
139
140         div_elem.appendChild(page_elem);
141         div_elem.appendChild(newline_node);
142     }
143
144     return div_elem;
145 }
146
147
148 function update_offset (offset) {
149     clearTimeout(searchtimer);
150     document.search.startrec.value = offset;
151     update_action('page');
152     check_search();
153     update_history();
154     return false;
155 }
156
157
158 function create_element (name, cdata) {
159     var elem_node = document.createElement(name);
160     var text_node = document.createTextNode(cdata);
161     elem_node.appendChild(text_node);
162
163     return elem_node;
164 }
165
166
167 function clear_cell (cell) {
168     while (cell.hasChildNodes())
169         cell.removeChild(cell.firstChild);
170 }
171
172
173 function append_text(cell, text) {
174     text_node = document.createTextNode(text);
175     cell.appendChild(text_node);
176 }
177
178
179 function assign_text (cell, text) {
180     clear_cell(cell);
181     append_text(cell, text);
182 }
183
184 function set_sort_opt(n, opt, str)
185 {
186     var txt = document.createTextNode(str);
187     if (opt == cur_sort)
188         n.appendChild(txt);
189     else
190     {
191         var a = document.createElement('a');
192         a.appendChild(txt);
193         a.setAttribute('href', "");
194         a.setAttribute('onclick', "set_sort('" + opt + "'); return false");
195         n.appendChild(a);
196     }
197 }
198
199 function set_sort(sort)
200 {
201     if (sort && sort != cur_sort)
202     {
203         cur_sort = sort;
204         if (searched)
205             check_search();
206     }
207
208     var t = document.getElementById("sortselect");
209     clear_cell(t);
210     t.appendChild(document.createTextNode("Sort results by: "));
211     set_sort_opt(t, 'relevance', 'Relevance');
212     t.appendChild(document.createTextNode(" or "));
213     set_sort_opt(t, 'title:1', 'Title');
214 }
215
216 function show_records()
217 {
218     if (xshow.readyState != 4)
219         return;
220     var i;
221     var xml = xshow.responseXML;
222     var body = document.getElementById("body");
223     var hits = xml.getElementsByTagName("hit");
224
225     clear_cell(body);
226
227     if (!hits[0]) // We should never get here with blocking operations
228     {
229         assign_text(body, 'No records yet');
230         searchtimer = setTimeout(check_search, 250);
231     }
232     else
233     {
234         var total = Number(xml.getElementsByTagName('total')[0].childNodes[0].nodeValue);
235         var merged = Number(xml.getElementsByTagName('merged')[0].childNodes[0].nodeValue);
236         var start = Number(xml.getElementsByTagName('start')[0].childNodes[0].nodeValue);
237         var num = Number(xml.getElementsByTagName('num')[0].childNodes[0].nodeValue);
238         var clients = Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
239         var pager = make_pager(merged, start,recstoshow);
240         var break_node1 = document.createElement('br');
241         var break_node2 = document.createElement('br');
242         var record_container = document.createElement('div');
243         var interval = create_element('div', 'Records : ' + (start + 1) +
244                                              ' to ' + (start + num) + ' of ' +
245                                              merged + ' (total hits: ' +
246                                              total + ')');
247         searched = 1;
248         interval.className = 'results';
249         record_container.className = 'records';
250
251         body.appendChild(pager);
252         body.appendChild(interval);
253         body.appendChild(break_node1);
254         body.appendChild(break_node2);
255         body.appendChild(record_container);
256
257         for (i = 0; i < hits.length; i++)
258         {
259             var tn = hits[i].getElementsByTagName("md-title");
260             var title = '';
261             var an = hits[i].getElementsByTagName("md-author");
262             var author = '';
263             var cn = hits[i].getElementsByTagName("count");
264             var count = 1;
265
266             if (tn[0]) {
267                 title = tn[0].childNodes[0].nodeValue;
268             } else {
269                 title = 'N/A';
270             }
271             if (an[0] && an[0].childNodes[0])
272                     author = an[0].childNodes[0].nodeValue;
273             if (cn[0])
274                 count = Number(cn[0].childNodes[0].nodeValue);
275             
276             var record_div = document.createElement('div');
277             record_div.className = 'record';
278
279             var record_cell = create_element('a', title);
280             record_cell.setAttribute('href', '#');
281             record_div.appendChild(record_cell);
282             if (author)
283             {
284                 record_div.appendChild(document.createTextNode(', by '));
285                 record_div.appendChild(document.createTextNode(author));
286             }
287             if (count > 1)
288                 record_div.appendChild(document.createTextNode(
289                         ' (' + count + ')'));
290             record_container.appendChild(record_div);
291         }
292
293         shown++;
294         if (clients > 0)
295         {
296             if (shown < 5)
297                 searchtimer = setTimeout(check_search, 1000);
298             else
299                 searchtimer = setTimeout(check_search, 2000);
300         }
301     }
302     if (!termtimer)
303         termtimer = setTimeout(check_termlist, 500);
304 }
305
306 function check_search()
307 {
308     clearTimeout(searchtimer);
309     var url = "search.pz2?" +
310         "command=show" +
311         "&start=" + document.search.startrec.value +
312         "&num=" + recstoshow +
313         "&session=" + session +
314         "&sort=" + cur_sort +
315         "&block=1";
316     xshow = GetXmlHttpObject();
317     xshow.onreadystatechange=show_records;
318     xshow.open("GET", url);
319     xshow.send(null);
320 }
321
322
323 function refine_query (obj) {
324     var term = obj.getAttribute('term');
325     var cur_termlist = obj.getAttribute('facet');
326     var query_cell = document.getElementById('query');
327     
328     term = term.replace(/[\(\)]/g, '');
329     
330     if (cur_termlist == 'subject')
331         query_cell.value += ' and su=(' + term + ')';
332     else if (cur_termlist == 'author')
333         query_cell.value += ' and au=(' + term + ')';
334
335     start_search();
336 }
337
338
339
340 function show_termlist()
341 {
342     if (xtermlist.readyState != 4)
343         return;
344
345     var i;
346     var xml = xtermlist.responseXML;
347     var body = facet_list[cur_facet][1];
348     var facet_name = facet_list[cur_facet][0];
349     var hits = xml.getElementsByTagName("term");
350     var clients =
351         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
352
353     cur_facet++;
354
355     if (cur_facet >= facet_list.length)
356         cur_facet = 0;
357
358     if (!hits[0])
359     {
360         termtimer = setTimeout(check_termlist, 500);
361     }
362     else
363     {
364         clear_cell(body);
365         
366         for (i = 0; i < hits.length; i++)
367         {
368             var namen = hits[i].getElementsByTagName("name");
369             var freqn = hits[i].getElementsByTagName("frequency");
370             if (namen[0])
371                 var term = namen[0].childNodes[0].nodeValue;
372                 var freq = freqn[0].childNodes[0].nodeValue;
373                 var refine_cell = create_element('a', term + ' (' + freq + ')');
374                 refine_cell.setAttribute('href', '#');
375                 refine_cell.setAttribute('term', term);
376                 refine_cell.setAttribute('facet', facet_name);
377                 refine_cell.onclick = function () {
378                     refine_query(this);
379                     return false;
380                 };
381                 body.appendChild(refine_cell);
382         }
383
384         if (clients > 0)
385             termtimer = setTimeout(check_termlist, 1000);
386     }
387 }
388
389 function check_termlist()
390 {
391     var facet_name = facet_list[cur_facet][0];
392     var url = "search.pz2?" +
393         "command=termlist" +
394         "&session=" + session +
395         "&name=" + facet_name;
396     xtermlist = GetXmlHttpObject();
397     xtermlist.onreadystatechange=show_termlist;
398     xtermlist.open("GET", url);
399     xtermlist.send(null);
400 }
401
402 function show_stat()
403 {
404     if (xstat.readyState != 4)
405         return;
406     var i;
407     var xml = xstat.responseXML;
408     var body = document.getElementById("stat");
409     var nodes = xml.childNodes[0].childNodes;
410     var clients =
411         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
412     if (!nodes[0])
413     {
414         stattimer  = setTimeout(check_stat, 500);
415     }
416     else
417     {
418         assign_text(body, '(');
419         for (i = 0; i < nodes.length; i++)
420         {
421             if (nodes[i].nodeType != 1)
422                 continue;
423             var value = nodes[i].childNodes[0].nodeValue;
424             if (value == 0)
425                 continue;
426             var name = nodes[i].nodeName;
427             append_text(body, ' ' + name + '=' + value);
428         }
429
430         append_text(body, ')');
431         if (clients > 0)
432             stattimer = setTimeout(check_stat, 2000);
433     }
434 }
435
436 function check_stat()
437 {
438     var url = "search.pz2?" +
439         "command=stat" +
440         "&session=" + session;
441     xstat = GetXmlHttpObject();
442     xstat.onreadystatechange=show_stat;
443     xstat.open("GET", url);
444     xstat.send(null);
445 }
446
447 function search_started()
448 {
449     if (xsearch.readyState != 4)
450         return;
451     var xml = xsearch.responseXML;
452     var error = xml.getElementsByTagName("error");
453     if (error[0])
454     {
455         var msg = error[0].childNodes[0].nodeValue;
456         alert(msg);
457         return;
458     }
459     check_search();
460     stattimer = setTimeout(check_stat, 1000);
461 }
462
463 function start_search()
464 {
465     clearTimeout(termtimer);
466     termtimer = 0;
467     clearTimeout(searchtimer);
468     searchtimer = 0;
469     clearTimeout(stattimer);
470     stattimer = 0;
471     clearTimeout(showtimer);
472     showtimer = 0;
473     var query = escape(document.getElementById('query').value);
474     var url = "search.pz2?" +
475         "command=search" +
476         "&session=" + session +
477         "&query=" + query;
478     xsearch = GetXmlHttpObject();
479     xsearch.onreadystatechange=search_started;
480     xsearch.open("GET", url);
481     xsearch.send(null);
482     clear_cell(document.getElementById("body"));
483     update_history();
484     shown = 0;
485     document.search.startrec.value = 0;
486 }
487
488 function session_encode ()
489 {
490     var i;
491     var session = '';
492
493     for (i = 0; i < session_cells.length; i++)
494     {
495         var name = session_cells[i];
496         var value = escape(document.getElementById(name).value);
497         session += '&' + name + '=' + value;
498     }
499
500     return session;
501 }
502
503
504 function session_restore (session)
505 {
506     var fields = session.split(/&/);
507     var i;
508
509     for (i = 1; i < fields.length; i++)
510     {
511         var pair = fields[i].split(/=/);
512         var key = pair.shift();
513         var value = pair.join('=');
514         var cell = document.getElementById(key);
515
516         cell.value = value;
517     }
518     
519 }
520
521
522 function session_read ()
523 {
524     var ses = window.location.hash.replace(/^#/, '');
525     return ses;
526 }
527
528
529 function session_store (new_value)
530 {
531     window.location.hash = '#' + new_value;
532 }
533
534
535 function update_history ()
536 {
537     var session = session_encode();
538     session_store(session);
539     old_session = session;
540 }
541
542
543 function session_check ()
544 {
545     var session = session_read();
546     var action = document.search.action_type.value;
547
548     clearInterval(url_surveillence);
549
550     if ( session != unescape(old_session) )
551     {
552         session_restore(session);
553
554         if (action == 'search') {
555             start_search();
556         } else if (action == 'page') {
557             check_search();
558         } else {
559             alert('Unregocnized action_type: ' + action);
560             return;
561         }
562     }
563     
564     url_surveillence = setInterval(session_check, 200);
565 }
566
567
568 function get_available_facets () {
569     var facet_container = document.getElementById('termlists');
570     var facet_cells = facet_container.childNodes;
571     var facets = Array();
572     var i;
573
574     for (i = 0; i < facet_cells.length; i++) {
575         var cell = facet_cells.item(i);
576
577         if (cell.className == 'facet') {
578             var facet_name = cell.id.replace(/^facet_([^_]+)_terms$/, "$1");
579             facets.push(Array(facet_name, cell));
580         }
581     }
582
583     return facets;
584 }
585
586
587 function get_facet_container (obj) {
588     return document.getElementById(obj.id + '_terms');
589 }
590
591
592 function toggle_facet (obj) {
593     var container = get_facet_container(obj);
594
595     if (obj.className == 'selected') {
596         obj.className = 'unselected';
597         container.style.display = 'inline';
598     } else {
599         obj.className = 'selected';
600         container.style.display = 'none';
601     }
602 }