Various changes to support IE
[pazpar2-moved-to-github.git] / www / demo / search.js
1 /* $Id: search.js,v 1.45 2007-01-26 18:50:11 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_sort = "relevance";
28 var searched = 0;
29 var cur_id = -1;
30 var cur_rec = 0;
31
32 function initialize ()
33 {
34     facet_list = get_available_facets();
35     start_session();
36     //session_check();
37     set_sort();
38 }
39
40 function GetXmlHttpObject()
41
42     var objXMLHttp=null
43     if (window.XMLHttpRequest)
44       {
45       objXMLHttp=new XMLHttpRequest()
46       }
47     else if (window.ActiveXObject)
48       {
49       objXMLHttp=new ActiveXObject("Microsoft.XMLHTTP")
50       }
51     return objXMLHttp
52
53
54 function SendXmlHttpObject(obj, url, handler)
55 {
56     obj.onreadystatechange=handler;
57     obj.open("GET", url);
58     obj.send(null);
59 }
60
61 function session_started()
62 {
63     if (xinitSession.readyState != 4)
64         return;
65     var xml = xinitSession.responseXML;
66     var sesid = xml.getElementsByTagName("session")[0].childNodes[0].nodeValue;
67     assign_text(document.getElementById("status"), 'Live');
68     session = sesid;
69     setTimeout(ping_session, 50000);
70 }
71
72 function start_session()
73 {
74     xinitSession = GetXmlHttpObject();
75     var url="search.pz2?";
76     url += "command=init";
77     xinitSession.onreadystatechange=session_started;
78     xinitSession.open("GET", url);
79     xinitSession.send(null);
80 }
81
82 function ping_session()
83 {
84     if (!session)
85         return;
86     var url = "search.pz2?command=ping&session=" + session;
87     SendXmlHttpObject(xpingSession = GetXmlHttpObject(), url, session_pinged);
88 }
89
90 function session_pinged()
91 {
92     if (xpingSession.readyState != 4)
93         return;
94     var xml = xpingSession.responseXML;
95     var error = xml.getElementsByTagName("error");
96     if (error[0])
97         location = "?";
98     else
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     elem_node.innerHTML = cdata;
158
159     return elem_node;
160 }
161
162
163 function clear_cell (cell) {
164     while (cell.hasChildNodes())
165         cell.removeChild(cell.firstChild);
166 }
167
168
169 function append_text(cell, text) {
170     text_node = document.createTextNode(text);
171     cell.appendChild(text_node);
172 }
173
174
175 function assign_text (cell, text) {
176     clear_cell(cell);
177     append_text(cell, text);
178 }
179
180 function set_sort_opt(n, opt, str)
181 {
182     var txt = document.createTextNode(str);
183     if (opt == cur_sort)
184         n.appendChild(txt);
185     else
186     {
187         var a = document.createElement('a');
188         a.appendChild(txt);
189         a.setAttribute('href', "");
190         a.setAttribute('id', opt);
191         a.onclick = function() { set_sort(this.getAttribute('id')); 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 if (name == 'md-url')
226         return 'URL';
227     else if (name == 'md-title')
228         return '@';
229     else if (name == 'md-id')
230         return 'Local ID';
231     else if (name == 'md-lccn')
232         return 'LCCN';
233     else if (name == 'recid')
234         return '@';
235     else if (name == 'location')
236         return '@';
237     else
238         return name;
239 }
240
241 function hyperlink_field(name)
242 {
243     if (name == 'md-author')
244         return 'au';
245     else if (name == 'md-subject')
246         return 'su';
247     else if (name == 'md-url')
248         return 'URL';
249     else
250         return 0;
251 }
252
253 function  paint_details_tr(name, dn)
254 {
255     //emit a table row
256     var dname = displayname(name);
257     var ln = create_element('b', dname);
258     var tln = document.createElement('td');
259     tln.width = '90';
260     tln.vAlign = 'top';
261     tln.appendChild(ln);
262     var tr = document.createElement('tr');
263     tr.appendChild(tln);
264     tr.appendChild(dn);
265     return tr;
266 }
267
268 function cleanurl(v)
269 {
270     var v1 = v;
271     var v2 = v1.replace(/\?.*$/, "");
272     var v3 = v2.replace(/http:\/\//, "");
273     return v3;
274 }
275
276 function paint_data_elements(target, node)
277 {
278     var nodes = node.childNodes;
279     var dn = 0;
280     var lastname = '';
281     var i;
282     for (i = 0; i < nodes.length; i++)
283     {
284         if (nodes[i].nodeType != 1)
285             continue;
286         var name = nodes[i].nodeName;
287         if (name == 'recid' || name == 'md-title')
288             continue;
289         if (name != lastname && lastname != 'location') 
290         {
291             if (dn)
292             {
293                 var tr = paint_details_tr(lastname, dn);
294                 target.appendChild(tr);
295             }
296             dn = document.createElement('td');
297             lastname = name;
298         }
299         if (name == 'location')
300         {
301             dn = document.createElement('td');
302             dn.appendChild(paint_subrecord(nodes[i]));
303             target.appendChild(paint_details_tr('Location', dn)); 
304             continue;
305         }
306         if (!nodes[i].childNodes[0])
307                 continue;
308         var value = nodes[i].childNodes[0].nodeValue;
309         if (dn.childNodes[0])
310             dn.appendChild(document.createTextNode('; '));
311         var hyl = hyperlink_field(name);
312         var nv;
313         if (hyl)
314         {
315             nv = create_element('a', cleanurl(value));
316             if (hyl == 'URL')
317             {
318                 nv.href = value;
319                 nv.target = '_blank';
320             }
321             else
322             {
323                 nv.href = '#';
324                 nv.setAttribute('term', value);
325                 nv.setAttribute('searchfield', hyl);
326                 nv.onclick = function() { hyperlink_search(this); return false; };
327             }
328         }
329         else if (name == 'md-lccn')
330         {
331             nv = document.createElement('span');
332             nv.appendChild(document.createTextNode(value + ' '));
333             var link = create_element('a', 'Show title in LoC');
334                 link.setAttribute('target', '_blank');
335                 link.setAttribute('href', 'http://catalog.loc.gov/cgi-bin/Pwebrecon.cgi?DB=local&CNT=10&CMD=10+records+per+page&CMD=lccn+' + value);
336             nv.appendChild(link);
337
338         }
339         else
340             nv = document.createTextNode(value);
341         dn.appendChild(nv);
342     }
343     if (dn && lastname != 'location')
344     {
345         var tr = paint_details_tr(lastname, dn);
346         target.appendChild(tr);
347     }
348 }
349
350 function paint_subrecord(node)
351 {
352     var table = document.createElement('table');
353     var tbody = document.createElement('tbody');
354     var zurl = node.getAttribute('id');
355     var name = node.getAttribute('name');
356     var tr;
357     var td;
358     if (name)
359         td = create_element('td', name);
360     else
361         td = create_element('td', zurl);
362     tr = paint_details_tr('Source', td);
363     tbody.appendChild(tr);
364     paint_data_elements(tbody, node);
365     table.appendChild(tbody);
366     return table;
367 }
368
369 function paint_details(body, xml)
370 {
371     clear_cell(body);
372     var table = document.createElement('table');
373     var tbody = document.createElement('tbody');
374     table.setAttribute('cellpadding', 2);
375     paint_data_elements(tbody, xml.childNodes[0]);
376     table.appendChild(tbody);
377     body.appendChild(table);
378     body.style.display = 'inline';
379 }
380
381 function show_details()
382 {
383     if (xfetchDetails.readyState != 4)
384         return;
385     var xml = xfetchDetails.responseXML;
386     var error = xml.getElementsByTagName("error");
387     if (error[0])
388     {
389         var msg = error[0].childNodes[0].nodeValue;
390         alert(msg);
391         location = "?";
392         return;
393     }
394
395     var idn = xml.getElementsByTagName('recid');
396     if (!idn[0])
397         return;
398     var id = idn[0].childNodes[0].nodeValue;
399     cur_id = id;
400     cur_rec = xml;
401
402     var nodes = document.getElementsByName('listrecord');
403     var i;
404     for (i = 0; i < nodes.length; i++)
405     {
406         var dets = nodes[i].getElementsByTagName('div');
407         if (dets[0])
408             dets[0].style.display = 'none';
409     }
410
411     var body = document.getElementById('rec_' + id);
412     if (!body)
413         return;
414     paint_details(body, xml);
415 }
416
417 function hyperlink_search(obj)
418 {
419     var field = obj.getAttribute('searchfield');
420     var term = obj.getAttribute('term');
421     var queryfield  = document.getElementById('query');
422     queryfield.value = field + '=' + term;
423     start_search();
424 }
425
426 function fetch_details(id)
427 {
428     cur_id = -1;
429     if (id == cur_id)
430     {
431         cur_id = -1;
432         return;
433     }
434     if (!session)
435         return;
436     var url = "search.pz2?session=" + session +
437         "&command=record" +
438         "&id=" + id;
439     SendXmlHttpObject(xfetchDetails = GetXmlHttpObject(), url, show_details);
440 }
441
442 function show_records()
443 {
444     if (xshow.readyState != 4)
445         return;
446     var i;
447     var xml = xshow.responseXML;
448     var body = document.getElementById("body");
449     var hits = xml.getElementsByTagName("hit");
450
451     clear_cell(body);
452
453     if (!hits[0]) // We should never get here with blocking operations
454     {
455         assign_text(body, 'No records yet');
456         searchtimer = setTimeout(check_search, 250);
457     }
458     else
459     {
460         var total = Number(xml.getElementsByTagName('total')[0].childNodes[0].nodeValue);
461         var merged = Number(xml.getElementsByTagName('merged')[0].childNodes[0].nodeValue);
462         var start = Number(xml.getElementsByTagName('start')[0].childNodes[0].nodeValue);
463         var num = Number(xml.getElementsByTagName('num')[0].childNodes[0].nodeValue);
464         var clients = Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
465         var pager = make_pager(merged, start,recstoshow);
466         var break_node1 = document.createElement('br');
467         var break_node2 = document.createElement('br');
468         var record_container = document.createElement('div');
469         var interval = create_element('div', 'Records : ' + (start + 1) +
470                                              ' to ' + (start + num) + ' of ' +
471                                              merged + ' (total hits: ' +
472                                              total + ')');
473         searched = 1;
474         interval.className = 'results';
475         record_container.className = 'records';
476
477         body.appendChild(pager);
478         body.appendChild(interval);
479         body.appendChild(break_node1);
480         body.appendChild(break_node2);
481         body.appendChild(record_container);
482
483         for (i = 0; i < hits.length; i++)
484         {
485             var tn = hits[i].getElementsByTagName("md-title");
486             var title = '';
487             var an = hits[i].getElementsByTagName("md-author");
488             var author = '';
489             var cn = hits[i].getElementsByTagName("count");
490             var count = 1;
491             var idn = hits[i].getElementsByTagName("recid");
492
493             if (tn[0] && tn[0].childNodes[0]) {
494                 title = tn[0].childNodes[0].nodeValue;
495             } else {
496                 title = 'N/A';
497             }
498             if (an[0] && an[0].childNodes[0])
499                     author = an[0].childNodes[0].nodeValue;
500             if (cn[0])
501                 count = Number(cn[0].childNodes[0].nodeValue);
502             var id = idn[0].childNodes[0].nodeValue;
503             
504             var record_div = document.createElement('div');
505             record_div.className = 'record';
506             record_div.setAttribute('name', 'listrecord');
507
508             var record_cell = create_element('a', title);
509             record_cell.setAttribute('href', '#' + id);
510             record_cell.setAttribute('id', id);
511             //record_cell.onclick = function() { fetch_details(this.getAttribute('id')); return false; }
512             record_cell.onclick = function() { fetch_details(this.getAttribute('id')); return false; };
513             record_div.appendChild(record_cell);
514             if (author)
515             {
516                 record_div.appendChild(document.createTextNode(', by '));
517                 var al = create_element('a', author);
518                 al.setAttribute('href', '#');
519                 al.setAttribute('term', author);
520                 al.setAttribute('searchfield', 'au');
521                 al.onclick = function() { hyperlink_search(this); return false; };
522                 record_div.appendChild(al);
523             }
524             if (count > 1)
525                 record_div.appendChild(document.createTextNode(
526                         ' (' + count + ')'));
527             var det_div = document.createElement('div');
528             if (id == cur_id)
529                 paint_details(det_div, cur_rec);
530             else
531                 det_div.style.display = 'none';
532             det_div.setAttribute('id', 'rec_' + id);
533             det_div.setAttribute('name', 'details');
534             record_div.appendChild(det_div);
535             record_container.appendChild(record_div);
536         }
537
538         shown++;
539         if (clients > 0)
540         {
541             if (shown < 5)
542                 searchtimer = setTimeout(check_search, 1000);
543             else
544                 searchtimer = setTimeout(check_search, 2000);
545         }
546     }
547     if (!termtimer)
548         termtimer = setTimeout(check_termlist, 500);
549 }
550
551 function check_search()
552 {
553     clearTimeout(searchtimer);
554     var url = "search.pz2?" +
555         "command=show" +
556         "&start=" + document.search.startrec.value +
557         "&num=" + recstoshow +
558         "&session=" + session +
559         "&sort=" + cur_sort +
560         "&block=1";
561     xshow = GetXmlHttpObject();
562     xshow.onreadystatechange=show_records;
563     xshow.open("GET", url);
564     xshow.send(null);
565 }
566
567
568 function refine_query (obj) {
569     var term = obj.getAttribute('term');
570     var cur_termlist = obj.getAttribute('facet');
571     var query_cell = document.getElementById('query');
572     
573     term = term.replace(/[\(\)]/g, '');
574     
575     if (cur_termlist == 'subject')
576         query_cell.value += ' and su="' + term + '"';
577     else if (cur_termlist == 'author')
578         query_cell.value += ' and au="' + term + '"';
579     else if (cur_termlist == 'date')
580         query_cell.value += ' and date="' + term + '"';
581
582     start_search();
583 }
584
585 function clear_termlists()
586 {
587     var i;
588     for (i = 0; i < facet_list.length; i++)
589         clear_cell(facet_list[i][1]);
590 }
591
592 function show_termlists()
593 {
594     if (xtermlist.readyState != 4)
595         return;
596
597     var i;
598     var xml = xtermlist.responseXML;
599     var clients =
600         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
601     var lists = xml.getElementsByTagName("list");
602
603     for (i = 0; i < lists.length; i++)
604     {
605         var listname = lists[i].getAttribute('name');
606         var body = document.getElementById('facet_' + listname + '_terms');
607         if (body.style.display == 'none')
608             continue;
609         clear_cell(body);
610         var terms = lists[i].getElementsByTagName('term');
611         var t;
612         for (t = 0; t < terms.length; t++)
613         {
614             var namen = terms[t].getElementsByTagName("name");
615             var freqn = terms[t].getElementsByTagName("frequency");
616             if (namen[0])
617                 var term = namen[0].childNodes[0].nodeValue;
618                 var freq = freqn[0].childNodes[0].nodeValue;
619                 var refine_cell = create_element('a', term + ' (' + freq + ')');
620                 refine_cell.setAttribute('href', '#');
621                 refine_cell.setAttribute('term', term);
622                 refine_cell.setAttribute('facet', listname);
623                 refine_cell.onclick = function () {
624                     refine_query(this);
625                     return false;
626                 };
627                 body.appendChild(refine_cell);
628         }
629     }
630     if (clients > 0)
631         termtimer = setTimeout(check_termlist, 1000);
632 }
633
634 function check_termlist()
635 {
636     var facet_names = '';
637     var i;
638     for (i = 0; i < facet_list.length; i++)
639         if (facet_list[i][1].style.display != 'none')
640         {
641             if (facet_names)
642                 facet_names += ',';
643             facet_names += facet_list[i][0];
644         }
645     var url = "search.pz2?" +
646         "command=termlist" +
647         "&session=" + session +
648         "&name=" + facet_names +
649         "&num=12";
650     SendXmlHttpObject(xtermlist = GetXmlHttpObject(), url, show_termlists);
651 }
652
653 function show_stat()
654 {
655     if (xstat.readyState != 4)
656         return;
657     var i;
658     var xml = xstat.responseXML;
659     var body = document.getElementById("stat");
660     var nodes = xml.childNodes[0].childNodes;
661     var clients =
662         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
663     if (!nodes[0])
664     {
665         stattimer  = setTimeout(check_stat, 500);
666     }
667     else
668     {
669         assign_text(body, '(');
670         for (i = 0; i < nodes.length; i++)
671         {
672             if (nodes[i].nodeType != 1)
673                 continue;
674             var value = nodes[i].childNodes[0].nodeValue;
675             if (value == 0)
676                 continue;
677             var name = nodes[i].nodeName;
678             append_text(body, ' ' + name + '=' + value);
679         }
680
681         append_text(body, ')');
682         if (clients > 0)
683             stattimer = setTimeout(check_stat, 2000);
684     }
685 }
686
687 function check_stat()
688 {
689     var url = "search.pz2?" +
690         "command=stat" +
691         "&session=" + session;
692     xstat = GetXmlHttpObject();
693     xstat.onreadystatechange=show_stat;
694     xstat.open("GET", url);
695     xstat.send(null);
696 }
697
698 function search_started()
699 {
700     if (xsearch.readyState != 4)
701         return;
702     var xml = xsearch.responseXML;
703     var error = xml.getElementsByTagName("error");
704     if (error[0])
705     {
706         var msg = error[0].childNodes[0].nodeValue;
707         alert(msg);
708         return;
709     }
710     check_search();
711     stattimer = setTimeout(check_stat, 1000);
712 }
713
714 function start_search()
715 {
716     clearTimeout(termtimer);
717     termtimer = 0;
718     clearTimeout(searchtimer);
719     searchtimer = 0;
720     clearTimeout(stattimer);
721     stattimer = 0;
722     clearTimeout(showtimer);
723     showtimer = 0;
724     cur_id = -1;
725     clear_termlists();
726     var query = escape(document.getElementById('query').value);
727     var url = "search.pz2?" +
728         "command=search" +
729         "&session=" + session +
730         "&query=" + query;
731     xsearch = GetXmlHttpObject();
732     xsearch.onreadystatechange=search_started;
733     xsearch.open("GET", url);
734     xsearch.send(null);
735     clear_cell(document.getElementById("body"));
736     update_history();
737     shown = 0;
738     document.search.startrec.value = 0;
739 }
740
741 function session_encode ()
742 {
743     var i;
744     var session = '';
745
746     for (i = 0; i < session_cells.length; i++)
747     {
748         var name = session_cells[i];
749         var value = escape(document.getElementById(name).value);
750         session += '&' + name + '=' + value;
751     }
752
753     return session;
754 }
755
756
757 function session_restore (session)
758 {
759     var fields = session.split(/&/);
760     var i;
761
762     for (i = 1; i < fields.length; i++)
763     {
764         var pair = fields[i].split(/=/);
765         var key = pair.shift();
766         var value = pair.join('=');
767         var cell = document.getElementById(key);
768
769         cell.value = value;
770     }
771     
772 }
773
774
775 function session_read ()
776 {
777     var ses = window.location.hash.replace(/^#/, '');
778     return ses;
779 }
780
781
782 function session_store (new_value)
783 {
784     window.location.hash = '#' + new_value;
785 }
786
787
788 function update_history ()
789 {
790     var session = session_encode();
791     session_store(session);
792     old_session = session;
793 }
794
795
796 function session_check ()
797 {
798     var session = session_read();
799     var action = document.search.action_type.value;
800
801     clearInterval(url_surveillence);
802
803     if ( session != unescape(old_session) )
804     {
805         session_restore(session);
806
807         if (action == 'search') {
808             start_search();
809         } else if (action == 'page') {
810             check_search();
811         } else {
812             alert('Unregocnized action_type: ' + action);
813             return;
814         }
815     }
816     
817     url_surveillence = setInterval(session_check, 200);
818 }
819
820
821 function get_available_facets () {
822     var facet_container = document.getElementById('termlists');
823     var facet_cells = facet_container.childNodes;
824     var facets = Array();
825     var i;
826
827     for (i = 0; i < facet_cells.length; i++) {
828         var cell = facet_cells.item(i);
829
830         if (cell.className == 'facet') {
831             var facet_name = cell.id.replace(/^facet_([^_]+)_terms$/, "$1");
832             facets.push(Array(facet_name, cell));
833         }
834     }
835
836     return facets;
837 }
838
839
840 function get_facet_container (obj) {
841     return document.getElementById(obj.id + '_terms');
842 }
843
844
845 function toggle_facet (obj) {
846     var container = get_facet_container(obj);
847
848     if (obj.className == 'selected') {
849         obj.className = 'unselected';
850         container.style.display = 'inline';
851         check_termlist();
852     } else {
853         obj.className = 'selected';
854         container.style.display = 'none';
855     }
856 }