Removed multiple lines
[pazpar2-moved-to-github.git] / www / demo / search.js
1 /* $Id: search.js,v 1.30 2007-01-16 19:21:05 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 xfetchDetails;
14 var session = false;
15 var targetsloaded = false;
16 var shown;
17 var searchtimer;
18 var showtimer;
19 var termtimer;
20 var stattimer;
21 var session_cells = Array('query', 'startrec', 'action_type');
22 var old_session = session_read();
23 var url_surveillence;
24 var recstoshow = 20;
25 var page_window = 5;  // Number of pages prior to and after the current page
26 var facet_list;
27 var cur_facet = 0;
28 var cur_sort = "relevance";
29 var searched = 0;
30 var cur_id = -1;
31 var cur_rec = 0;
32
33 function initialize ()
34 {
35     facet_list = get_available_facets();
36     start_session();
37     session_check();
38     set_sort();
39 }
40
41 function GetXmlHttpObject()
42
43     var objXMLHttp=null
44     if (window.XMLHttpRequest)
45       {
46       objXMLHttp=new XMLHttpRequest()
47       }
48     else if (window.ActiveXObject)
49       {
50       objXMLHttp=new ActiveXObject("Microsoft.XMLHTTP")
51       }
52     return objXMLHttp
53
54
55 function SendXmlHttpObject(obj, url, handler)
56 {
57     obj.onreadystatechange=handler;
58     obj.open("GET", url);
59     obj.send(null);
60 }
61
62 function session_started()
63 {
64     if (xinitSession.readyState != 4)
65         return;
66     var xml = xinitSession.responseXML;
67     var sesid = xml.getElementsByTagName("session")[0].childNodes[0].nodeValue;
68     assign_text(document.getElementById("status"), 'Live');
69     session = sesid;
70     setTimeout(ping_session, 50000);
71 }
72
73 function start_session()
74 {
75     xinitSession = GetXmlHttpObject();
76     var url="search.pz2?";
77     url += "command=init";
78     xinitSession.onreadystatechange=session_started;
79     xinitSession.open("GET", url);
80     xinitSession.send(null);
81 }
82
83 function ping_session()
84 {
85     if (!session)
86         return;
87     var url = "search.pz2?command=ping&session=" + session;
88     SendXmlHttpObject(xpingSession = GetXmlHttpObject(), url, session_pinged);
89 }
90
91 function session_pinged()
92 {
93     if (xpingSession.readyState != 4)
94         return;
95     var xml = xpingSession.responseXML;
96     var error = xml.getElementsByTagName("error");
97     if (error[0])
98         location = "?";
99     setTimeout(ping_session, 50000);
100 }
101
102 function update_action (new_action) {
103     document.search.action_type.value = new_action;
104 }
105
106
107 function make_pager (hits, offset, max) {
108     var html = '';
109     var off;
110     var start_offset = offset - page_window * max;
111     var div_elem = document.createElement('div');
112     
113     div_elem.className = 'pages';
114
115     if (start_offset < 0) {
116         start_offset = 0;
117     }
118
119     for (off = start_offset;
120          off < hits && off < (start_offset + 2 * page_window * max); 
121          off += max) {
122         
123         var p = off / max + 1;
124         var page_elem = create_element('a', p);
125         var newline_node = document.createTextNode(' ');
126
127         if ((offset >= off) && (offset < (off + max))) {
128             page_elem.className = 'select';
129         }
130
131         page_elem.setAttribute('off', off);
132         page_elem.style.cursor = 'pointer';
133         page_elem.onclick = function () {
134             update_offset(this.getAttribute('off'));
135         };
136
137         div_elem.appendChild(page_elem);
138         div_elem.appendChild(newline_node);
139     }
140
141     return div_elem;
142 }
143
144
145 function update_offset (offset) {
146     clearTimeout(searchtimer);
147     document.search.startrec.value = offset;
148     update_action('page');
149     check_search();
150     update_history();
151     return false;
152 }
153
154
155 function create_element (name, cdata) {
156     var elem_node = document.createElement(name);
157     var text_node = document.createTextNode(cdata);
158     elem_node.appendChild(text_node);
159
160     return elem_node;
161 }
162
163
164 function clear_cell (cell) {
165     while (cell.hasChildNodes())
166         cell.removeChild(cell.firstChild);
167 }
168
169
170 function append_text(cell, text) {
171     text_node = document.createTextNode(text);
172     cell.appendChild(text_node);
173 }
174
175
176 function assign_text (cell, text) {
177     clear_cell(cell);
178     append_text(cell, text);
179 }
180
181 function set_sort_opt(n, opt, str)
182 {
183     var txt = document.createTextNode(str);
184     if (opt == cur_sort)
185         n.appendChild(txt);
186     else
187     {
188         var a = document.createElement('a');
189         a.appendChild(txt);
190         a.setAttribute('href', "");
191         a.setAttribute('onclick', "set_sort('" + opt + "'); return false");
192         n.appendChild(a);
193     }
194 }
195
196 function set_sort(sort)
197 {
198     if (sort && sort != cur_sort)
199     {
200         cur_sort = sort;
201         if (searched)
202             check_search();
203     }
204
205     var t = document.getElementById("sortselect");
206     clear_cell(t);
207     t.appendChild(document.createTextNode("Sort results by: "));
208     set_sort_opt(t, 'relevance', 'Relevance');
209     t.appendChild(document.createTextNode(" or "));
210     set_sort_opt(t, 'title:1', 'Title');
211 }
212
213 function displayname(name)
214 {
215     if (name == 'md-author')
216         return 'Author';
217     else if (name == 'md-subject')
218         return 'Subject';
219     else if (name == 'md-date')
220         return 'Date';
221     else if (name == 'md-isbn')
222         return 'ISBN';
223     else if (name == 'md-publisher')
224         return 'Publisher';
225     else
226         return name;
227 }
228
229 function  paint_details_tr(name, dn)
230 {
231     //emit a table row
232     var dname = displayname(name);
233     var ln = create_element('b', dname);
234     var tln = document.createElement('td');
235     tln.setAttribute('width', 70);
236     tln.appendChild(ln);
237     var tr = document.createElement('tr');
238     tr.appendChild(tln);
239     tr.appendChild(dn);
240     return tr;
241 }
242
243 function paint_details(body, xml)
244 {
245     clear_cell(body);
246     //body.appendChild(document.createElement('br'));
247     var nodes = xml.childNodes[0].childNodes;
248     var i;
249     var table = document.createElement('table');
250     table.setAttribute('cellpadding', 2);
251     var dn = 0;
252     var lastname = '';
253     for (i = 0; i < nodes.length; i++)
254     {
255         if (nodes[i].nodeType != 1)
256             continue;
257         var name = nodes[i].nodeName;
258         if (name == 'recid' || name == 'md-title')
259             continue;
260         if (name != lastname)
261         {
262             if (dn)
263             {
264                 var tr = paint_details_tr(lastname, dn);
265                 table.appendChild(tr);
266             }
267             dn = document.createElement('td');
268             lastname = name;
269         }
270
271         if (!nodes[i].childNodes[0])
272                 continue;
273         var value = nodes[i].childNodes[0].nodeValue;
274         if (dn.childNodes[0])
275             value = '; ' + value;
276         var nv = document.createTextNode(value);
277         dn.appendChild(nv);
278     }
279     if (dn)
280     {
281         var tr = paint_details_tr(lastname, dn);
282         table.appendChild(tr);
283     }
284     body.appendChild(table);
285     body.style.display = 'inline';
286 }
287
288 function show_details()
289 {
290     if (xfetchDetails.readyState != 4)
291         return;
292     var xml = xfetchDetails.responseXML;
293     var error = xml.getElementsByTagName("error");
294     if (error[0])
295     {
296         var msg = error[0].childNodes[0].nodeValue;
297         alert(msg);
298         location = "?";
299         return;
300     }
301
302     // This is some ugly display code. Replace with your own ting o'beauty
303
304     var idn = xml.getElementsByTagName('recid');
305     if (!idn[0])
306         return;
307     var id = idn[0].childNodes[0].nodeValue;
308     cur_id = id;
309     cur_rec = xml;
310
311     var body = document.getElementById('rec_' + id);
312     if (!body)
313         return;
314     paint_details(body, xml);
315 }
316
317 function hyperlink_search(field, obj)
318 {
319     var term = obj.getAttribute('term');
320     var queryfield  = document.getElementById('query');
321     queryfield.value = field + '=' + term;
322     start_search();
323 }
324
325 function fetch_details(id)
326 {
327     cur_id = -1;
328     var nodes = document.getElementsByName('listrecord');
329     var i;
330     for (i = 0; i < nodes.length; i++)
331     {
332         var dets = nodes[i].getElementsByTagName('div');
333         if (dets[0])
334             dets[0].style.display = 'none';
335     }
336     if (id == cur_id)
337     {
338         cur_id = -1;
339         return;
340     }
341     if (!session)
342         return;
343     var url = "search.pz2?session=" + session +
344         "&command=record" +
345         "&id=" + id;
346     SendXmlHttpObject(xfetchDetails = GetXmlHttpObject(), url, show_details);
347 }
348
349 function show_records()
350 {
351     if (xshow.readyState != 4)
352         return;
353     var i;
354     var xml = xshow.responseXML;
355     var body = document.getElementById("body");
356     var hits = xml.getElementsByTagName("hit");
357
358     clear_cell(body);
359
360     if (!hits[0]) // We should never get here with blocking operations
361     {
362         assign_text(body, 'No records yet');
363         searchtimer = setTimeout(check_search, 250);
364     }
365     else
366     {
367         var total = Number(xml.getElementsByTagName('total')[0].childNodes[0].nodeValue);
368         var merged = Number(xml.getElementsByTagName('merged')[0].childNodes[0].nodeValue);
369         var start = Number(xml.getElementsByTagName('start')[0].childNodes[0].nodeValue);
370         var num = Number(xml.getElementsByTagName('num')[0].childNodes[0].nodeValue);
371         var clients = Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
372         var pager = make_pager(merged, start,recstoshow);
373         var break_node1 = document.createElement('br');
374         var break_node2 = document.createElement('br');
375         var record_container = document.createElement('div');
376         var interval = create_element('div', 'Records : ' + (start + 1) +
377                                              ' to ' + (start + num) + ' of ' +
378                                              merged + ' (total hits: ' +
379                                              total + ')');
380         searched = 1;
381         interval.className = 'results';
382         record_container.className = 'records';
383
384         body.appendChild(pager);
385         body.appendChild(interval);
386         body.appendChild(break_node1);
387         body.appendChild(break_node2);
388         body.appendChild(record_container);
389
390         for (i = 0; i < hits.length; i++)
391         {
392             var tn = hits[i].getElementsByTagName("md-title");
393             var title = '';
394             var an = hits[i].getElementsByTagName("md-author");
395             var author = '';
396             var cn = hits[i].getElementsByTagName("count");
397             var count = 1;
398             var idn = hits[i].getElementsByTagName("recid");
399
400             if (tn[0]) {
401                 title = tn[0].childNodes[0].nodeValue;
402             } else {
403                 title = 'N/A';
404             }
405             if (an[0] && an[0].childNodes[0])
406                     author = an[0].childNodes[0].nodeValue;
407             if (cn[0])
408                 count = Number(cn[0].childNodes[0].nodeValue);
409             var id = idn[0].childNodes[0].nodeValue;
410             
411             var record_div = document.createElement('div');
412             record_div.className = 'record';
413             record_div.setAttribute('name', 'listrecord');
414
415             var record_cell = create_element('a', title);
416             record_cell.setAttribute('href', '#');
417             record_cell.setAttribute('onclick', 'fetch_details(' + id + '); return false');
418             record_div.appendChild(record_cell);
419             if (author)
420             {
421                 record_div.appendChild(document.createTextNode(', by '));
422                 var al = create_element('a', author);
423                 al.setAttribute('href', '#');
424                 al.setAttribute('term', author);
425                 al.onclick = function() { hyperlink_search('au', this); return false; };
426                 record_div.appendChild(al);
427             }
428             if (count > 1)
429                 record_div.appendChild(document.createTextNode(
430                         ' (' + count + ')'));
431             var det_div = document.createElement('div');
432             if (id == cur_id)
433                 paint_details(det_div, cur_rec);
434             else
435                 det_div.style.display = 'none';
436             det_div.setAttribute('id', 'rec_' + id);
437             det_div.setAttribute('name', 'details');
438             record_div.appendChild(det_div);
439             record_container.appendChild(record_div);
440         }
441
442         shown++;
443         if (clients > 0)
444         {
445             if (shown < 5)
446                 searchtimer = setTimeout(check_search, 1000);
447             else
448                 searchtimer = setTimeout(check_search, 2000);
449         }
450     }
451     if (!termtimer)
452         termtimer = setTimeout(check_termlist, 500);
453 }
454
455 function check_search()
456 {
457     clearTimeout(searchtimer);
458     var url = "search.pz2?" +
459         "command=show" +
460         "&start=" + document.search.startrec.value +
461         "&num=" + recstoshow +
462         "&session=" + session +
463         "&sort=" + cur_sort +
464         "&block=1";
465     xshow = GetXmlHttpObject();
466     xshow.onreadystatechange=show_records;
467     xshow.open("GET", url);
468     xshow.send(null);
469 }
470
471
472 function refine_query (obj) {
473     var term = obj.getAttribute('term');
474     var cur_termlist = obj.getAttribute('facet');
475     var query_cell = document.getElementById('query');
476     
477     term = term.replace(/[\(\)]/g, '');
478     
479     if (cur_termlist == 'subject')
480         query_cell.value += ' and su=(' + term + ')';
481     else if (cur_termlist == 'author')
482         query_cell.value += ' and au=(' + term + ')';
483
484     start_search();
485 }
486
487
488
489 function show_termlist()
490 {
491     if (xtermlist.readyState != 4)
492         return;
493
494     var i;
495     var xml = xtermlist.responseXML;
496     var body = facet_list[cur_facet][1];
497     var facet_name = facet_list[cur_facet][0];
498     var hits = xml.getElementsByTagName("term");
499     var clients =
500         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
501
502     cur_facet++;
503
504     if (cur_facet >= facet_list.length)
505         cur_facet = 0;
506
507     if (!hits[0])
508     {
509         termtimer = setTimeout(check_termlist, 500);
510     }
511     else
512     {
513         clear_cell(body);
514         
515         for (i = 0; i < hits.length; i++)
516         {
517             var namen = hits[i].getElementsByTagName("name");
518             var freqn = hits[i].getElementsByTagName("frequency");
519             if (namen[0])
520                 var term = namen[0].childNodes[0].nodeValue;
521                 var freq = freqn[0].childNodes[0].nodeValue;
522                 var refine_cell = create_element('a', term + ' (' + freq + ')');
523                 refine_cell.setAttribute('href', '#');
524                 refine_cell.setAttribute('term', term);
525                 refine_cell.setAttribute('facet', facet_name);
526                 refine_cell.onclick = function () {
527                     refine_query(this);
528                     return false;
529                 };
530                 body.appendChild(refine_cell);
531         }
532
533         if (clients > 0)
534             termtimer = setTimeout(check_termlist, 1000);
535     }
536 }
537
538 function check_termlist()
539 {
540     var facet_name = facet_list[cur_facet][0];
541     var url = "search.pz2?" +
542         "command=termlist" +
543         "&session=" + session +
544         "&name=" + facet_name;
545     xtermlist = GetXmlHttpObject();
546     xtermlist.onreadystatechange=show_termlist;
547     xtermlist.open("GET", url);
548     xtermlist.send(null);
549 }
550
551 function show_stat()
552 {
553     if (xstat.readyState != 4)
554         return;
555     var i;
556     var xml = xstat.responseXML;
557     var body = document.getElementById("stat");
558     var nodes = xml.childNodes[0].childNodes;
559     var clients =
560         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
561     if (!nodes[0])
562     {
563         stattimer  = setTimeout(check_stat, 500);
564     }
565     else
566     {
567         assign_text(body, '(');
568         for (i = 0; i < nodes.length; i++)
569         {
570             if (nodes[i].nodeType != 1)
571                 continue;
572             var value = nodes[i].childNodes[0].nodeValue;
573             if (value == 0)
574                 continue;
575             var name = nodes[i].nodeName;
576             append_text(body, ' ' + name + '=' + value);
577         }
578
579         append_text(body, ')');
580         if (clients > 0)
581             stattimer = setTimeout(check_stat, 2000);
582     }
583 }
584
585 function check_stat()
586 {
587     var url = "search.pz2?" +
588         "command=stat" +
589         "&session=" + session;
590     xstat = GetXmlHttpObject();
591     xstat.onreadystatechange=show_stat;
592     xstat.open("GET", url);
593     xstat.send(null);
594 }
595
596 function search_started()
597 {
598     if (xsearch.readyState != 4)
599         return;
600     var xml = xsearch.responseXML;
601     var error = xml.getElementsByTagName("error");
602     if (error[0])
603     {
604         var msg = error[0].childNodes[0].nodeValue;
605         alert(msg);
606         return;
607     }
608     check_search();
609     stattimer = setTimeout(check_stat, 1000);
610 }
611
612 function start_search()
613 {
614     clearTimeout(termtimer);
615     termtimer = 0;
616     clearTimeout(searchtimer);
617     searchtimer = 0;
618     clearTimeout(stattimer);
619     stattimer = 0;
620     clearTimeout(showtimer);
621     showtimer = 0;
622     cur_id = -1;
623     var query = escape(document.getElementById('query').value);
624     var url = "search.pz2?" +
625         "command=search" +
626         "&session=" + session +
627         "&query=" + query;
628     xsearch = GetXmlHttpObject();
629     xsearch.onreadystatechange=search_started;
630     xsearch.open("GET", url);
631     xsearch.send(null);
632     clear_cell(document.getElementById("body"));
633     update_history();
634     shown = 0;
635     document.search.startrec.value = 0;
636 }
637
638 function session_encode ()
639 {
640     var i;
641     var session = '';
642
643     for (i = 0; i < session_cells.length; i++)
644     {
645         var name = session_cells[i];
646         var value = escape(document.getElementById(name).value);
647         session += '&' + name + '=' + value;
648     }
649
650     return session;
651 }
652
653
654 function session_restore (session)
655 {
656     var fields = session.split(/&/);
657     var i;
658
659     for (i = 1; i < fields.length; i++)
660     {
661         var pair = fields[i].split(/=/);
662         var key = pair.shift();
663         var value = pair.join('=');
664         var cell = document.getElementById(key);
665
666         cell.value = value;
667     }
668     
669 }
670
671
672 function session_read ()
673 {
674     var ses = window.location.hash.replace(/^#/, '');
675     return ses;
676 }
677
678
679 function session_store (new_value)
680 {
681     window.location.hash = '#' + new_value;
682 }
683
684
685 function update_history ()
686 {
687     var session = session_encode();
688     session_store(session);
689     old_session = session;
690 }
691
692
693 function session_check ()
694 {
695     var session = session_read();
696     var action = document.search.action_type.value;
697
698     clearInterval(url_surveillence);
699
700     if ( session != unescape(old_session) )
701     {
702         session_restore(session);
703
704         if (action == 'search') {
705             start_search();
706         } else if (action == 'page') {
707             check_search();
708         } else {
709             alert('Unregocnized action_type: ' + action);
710             return;
711         }
712     }
713     
714     url_surveillence = setInterval(session_check, 200);
715 }
716
717
718 function get_available_facets () {
719     var facet_container = document.getElementById('termlists');
720     var facet_cells = facet_container.childNodes;
721     var facets = Array();
722     var i;
723
724     for (i = 0; i < facet_cells.length; i++) {
725         var cell = facet_cells.item(i);
726
727         if (cell.className == 'facet') {
728             var facet_name = cell.id.replace(/^facet_([^_]+)_terms$/, "$1");
729             facets.push(Array(facet_name, cell));
730         }
731     }
732
733     return facets;
734 }
735
736
737 function get_facet_container (obj) {
738     return document.getElementById(obj.id + '_terms');
739 }
740
741
742 function toggle_facet (obj) {
743     var container = get_facet_container(obj);
744
745     if (obj.className == 'selected') {
746         obj.className = 'unselected';
747         container.style.display = 'inline';
748     } else {
749         obj.className = 'selected';
750         container.style.display = 'none';
751     }
752 }