Hyperlink searching off author and subject field in full view
[pazpar2-moved-to-github.git] / www / demo / search.js
1 /* $Id: search.js,v 1.32 2007-01-16 19:42:20 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 hyperlink_field(name)
230 {
231     if (name == 'md-author')
232         return 'au';
233     else if (name == 'md-subject')
234         return 'su';
235     else
236         return 0;
237 }
238
239 function  paint_details_tr(name, dn)
240 {
241     //emit a table row
242     var dname = displayname(name);
243     var ln = create_element('b', dname);
244     var tln = document.createElement('td');
245     tln.setAttribute('width', 70);
246     tln.setAttribute('valign', 'top');
247     tln.appendChild(ln);
248     var tr = document.createElement('tr');
249     tr.appendChild(tln);
250     tr.appendChild(dn);
251     return tr;
252 }
253
254 function paint_details(body, xml)
255 {
256     // This is some ugly display code. Replace with your own ting o'beauty
257     clear_cell(body);
258     //body.appendChild(document.createElement('br'));
259     var nodes = xml.childNodes[0].childNodes;
260     var i;
261     var table = document.createElement('table');
262     table.setAttribute('cellpadding', 2);
263     var dn = 0;
264     var lastname = '';
265     for (i = 0; i < nodes.length; i++)
266     {
267         if (nodes[i].nodeType != 1)
268             continue;
269         var name = nodes[i].nodeName;
270         if (name == 'recid' || name == 'md-title')
271             continue;
272         if (name != lastname)
273         {
274             if (dn)
275             {
276                 var tr = paint_details_tr(lastname, dn);
277                 table.appendChild(tr);
278             }
279             dn = document.createElement('td');
280             lastname = name;
281         }
282
283         if (!nodes[i].childNodes[0])
284                 continue;
285         var value = nodes[i].childNodes[0].nodeValue;
286         if (dn.childNodes[0])
287             dn.appendChild(document.createTextNode('; '));
288         var hyl = hyperlink_field(name);
289         var nv;
290         if (hyl)
291         {
292             nv = create_element('a', value);
293             nv.setAttribute('href', '#');
294             nv.setAttribute('term', value);
295             nv.setAttribute('searchfield', hyl);
296             nv.onclick = function() { hyperlink_search(this); return false; };
297         }
298         else
299             nv = document.createTextNode(value);
300         dn.appendChild(nv);
301     }
302     if (dn)
303     {
304         var tr = paint_details_tr(lastname, dn);
305         table.appendChild(tr);
306     }
307     body.appendChild(table);
308     body.style.display = 'inline';
309 }
310
311 function show_details()
312 {
313     if (xfetchDetails.readyState != 4)
314         return;
315     var xml = xfetchDetails.responseXML;
316     var error = xml.getElementsByTagName("error");
317     if (error[0])
318     {
319         var msg = error[0].childNodes[0].nodeValue;
320         alert(msg);
321         location = "?";
322         return;
323     }
324
325     var idn = xml.getElementsByTagName('recid');
326     if (!idn[0])
327         return;
328     var id = idn[0].childNodes[0].nodeValue;
329     cur_id = id;
330     cur_rec = xml;
331
332     var body = document.getElementById('rec_' + id);
333     if (!body)
334         return;
335     paint_details(body, xml);
336 }
337
338 function hyperlink_search(obj)
339 {
340     var field = obj.getAttribute('searchfield');
341     var term = obj.getAttribute('term');
342     var queryfield  = document.getElementById('query');
343     queryfield.value = field + '=' + term;
344     start_search();
345 }
346
347 function fetch_details(id)
348 {
349     cur_id = -1;
350     var nodes = document.getElementsByName('listrecord');
351     var i;
352     for (i = 0; i < nodes.length; i++)
353     {
354         var dets = nodes[i].getElementsByTagName('div');
355         if (dets[0])
356             dets[0].style.display = 'none';
357     }
358     if (id == cur_id)
359     {
360         cur_id = -1;
361         return;
362     }
363     if (!session)
364         return;
365     var url = "search.pz2?session=" + session +
366         "&command=record" +
367         "&id=" + id;
368     SendXmlHttpObject(xfetchDetails = GetXmlHttpObject(), url, show_details);
369 }
370
371 function show_records()
372 {
373     if (xshow.readyState != 4)
374         return;
375     var i;
376     var xml = xshow.responseXML;
377     var body = document.getElementById("body");
378     var hits = xml.getElementsByTagName("hit");
379
380     clear_cell(body);
381
382     if (!hits[0]) // We should never get here with blocking operations
383     {
384         assign_text(body, 'No records yet');
385         searchtimer = setTimeout(check_search, 250);
386     }
387     else
388     {
389         var total = Number(xml.getElementsByTagName('total')[0].childNodes[0].nodeValue);
390         var merged = Number(xml.getElementsByTagName('merged')[0].childNodes[0].nodeValue);
391         var start = Number(xml.getElementsByTagName('start')[0].childNodes[0].nodeValue);
392         var num = Number(xml.getElementsByTagName('num')[0].childNodes[0].nodeValue);
393         var clients = Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
394         var pager = make_pager(merged, start,recstoshow);
395         var break_node1 = document.createElement('br');
396         var break_node2 = document.createElement('br');
397         var record_container = document.createElement('div');
398         var interval = create_element('div', 'Records : ' + (start + 1) +
399                                              ' to ' + (start + num) + ' of ' +
400                                              merged + ' (total hits: ' +
401                                              total + ')');
402         searched = 1;
403         interval.className = 'results';
404         record_container.className = 'records';
405
406         body.appendChild(pager);
407         body.appendChild(interval);
408         body.appendChild(break_node1);
409         body.appendChild(break_node2);
410         body.appendChild(record_container);
411
412         for (i = 0; i < hits.length; i++)
413         {
414             var tn = hits[i].getElementsByTagName("md-title");
415             var title = '';
416             var an = hits[i].getElementsByTagName("md-author");
417             var author = '';
418             var cn = hits[i].getElementsByTagName("count");
419             var count = 1;
420             var idn = hits[i].getElementsByTagName("recid");
421
422             if (tn[0]) {
423                 title = tn[0].childNodes[0].nodeValue;
424             } else {
425                 title = 'N/A';
426             }
427             if (an[0] && an[0].childNodes[0])
428                     author = an[0].childNodes[0].nodeValue;
429             if (cn[0])
430                 count = Number(cn[0].childNodes[0].nodeValue);
431             var id = idn[0].childNodes[0].nodeValue;
432             
433             var record_div = document.createElement('div');
434             record_div.className = 'record';
435             record_div.setAttribute('name', 'listrecord');
436
437             var record_cell = create_element('a', title);
438             record_cell.setAttribute('href', '#');
439             record_cell.setAttribute('onclick', 'fetch_details(' + id + '); return false');
440             record_div.appendChild(record_cell);
441             if (author)
442             {
443                 record_div.appendChild(document.createTextNode(', by '));
444                 var al = create_element('a', author);
445                 al.setAttribute('href', '#');
446                 al.setAttribute('term', author);
447                 al.setAttribute('searchfield', 'au');
448                 al.onclick = function() { hyperlink_search(this); return false; };
449                 record_div.appendChild(al);
450             }
451             if (count > 1)
452                 record_div.appendChild(document.createTextNode(
453                         ' (' + count + ')'));
454             var det_div = document.createElement('div');
455             if (id == cur_id)
456                 paint_details(det_div, cur_rec);
457             else
458                 det_div.style.display = 'none';
459             det_div.setAttribute('id', 'rec_' + id);
460             det_div.setAttribute('name', 'details');
461             record_div.appendChild(det_div);
462             record_container.appendChild(record_div);
463         }
464
465         shown++;
466         if (clients > 0)
467         {
468             if (shown < 5)
469                 searchtimer = setTimeout(check_search, 1000);
470             else
471                 searchtimer = setTimeout(check_search, 2000);
472         }
473     }
474     if (!termtimer)
475         termtimer = setTimeout(check_termlist, 500);
476 }
477
478 function check_search()
479 {
480     clearTimeout(searchtimer);
481     var url = "search.pz2?" +
482         "command=show" +
483         "&start=" + document.search.startrec.value +
484         "&num=" + recstoshow +
485         "&session=" + session +
486         "&sort=" + cur_sort +
487         "&block=1";
488     xshow = GetXmlHttpObject();
489     xshow.onreadystatechange=show_records;
490     xshow.open("GET", url);
491     xshow.send(null);
492 }
493
494
495 function refine_query (obj) {
496     var term = obj.getAttribute('term');
497     var cur_termlist = obj.getAttribute('facet');
498     var query_cell = document.getElementById('query');
499     
500     term = term.replace(/[\(\)]/g, '');
501     
502     if (cur_termlist == 'subject')
503         query_cell.value += ' and su=(' + term + ')';
504     else if (cur_termlist == 'author')
505         query_cell.value += ' and au=(' + term + ')';
506
507     start_search();
508 }
509
510
511
512 function show_termlist()
513 {
514     if (xtermlist.readyState != 4)
515         return;
516
517     var i;
518     var xml = xtermlist.responseXML;
519     var body = facet_list[cur_facet][1];
520     var facet_name = facet_list[cur_facet][0];
521     var hits = xml.getElementsByTagName("term");
522     var clients =
523         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
524
525     cur_facet++;
526
527     if (cur_facet >= facet_list.length)
528         cur_facet = 0;
529
530     if (!hits[0])
531     {
532         termtimer = setTimeout(check_termlist, 500);
533     }
534     else
535     {
536         clear_cell(body);
537         
538         for (i = 0; i < hits.length; i++)
539         {
540             var namen = hits[i].getElementsByTagName("name");
541             var freqn = hits[i].getElementsByTagName("frequency");
542             if (namen[0])
543                 var term = namen[0].childNodes[0].nodeValue;
544                 var freq = freqn[0].childNodes[0].nodeValue;
545                 var refine_cell = create_element('a', term + ' (' + freq + ')');
546                 refine_cell.setAttribute('href', '#');
547                 refine_cell.setAttribute('term', term);
548                 refine_cell.setAttribute('facet', facet_name);
549                 refine_cell.onclick = function () {
550                     refine_query(this);
551                     return false;
552                 };
553                 body.appendChild(refine_cell);
554         }
555
556         if (clients > 0)
557             termtimer = setTimeout(check_termlist, 1000);
558     }
559 }
560
561 function check_termlist()
562 {
563     var facet_name = facet_list[cur_facet][0];
564     var url = "search.pz2?" +
565         "command=termlist" +
566         "&session=" + session +
567         "&name=" + facet_name;
568     xtermlist = GetXmlHttpObject();
569     xtermlist.onreadystatechange=show_termlist;
570     xtermlist.open("GET", url);
571     xtermlist.send(null);
572 }
573
574 function show_stat()
575 {
576     if (xstat.readyState != 4)
577         return;
578     var i;
579     var xml = xstat.responseXML;
580     var body = document.getElementById("stat");
581     var nodes = xml.childNodes[0].childNodes;
582     var clients =
583         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
584     if (!nodes[0])
585     {
586         stattimer  = setTimeout(check_stat, 500);
587     }
588     else
589     {
590         assign_text(body, '(');
591         for (i = 0; i < nodes.length; i++)
592         {
593             if (nodes[i].nodeType != 1)
594                 continue;
595             var value = nodes[i].childNodes[0].nodeValue;
596             if (value == 0)
597                 continue;
598             var name = nodes[i].nodeName;
599             append_text(body, ' ' + name + '=' + value);
600         }
601
602         append_text(body, ')');
603         if (clients > 0)
604             stattimer = setTimeout(check_stat, 2000);
605     }
606 }
607
608 function check_stat()
609 {
610     var url = "search.pz2?" +
611         "command=stat" +
612         "&session=" + session;
613     xstat = GetXmlHttpObject();
614     xstat.onreadystatechange=show_stat;
615     xstat.open("GET", url);
616     xstat.send(null);
617 }
618
619 function search_started()
620 {
621     if (xsearch.readyState != 4)
622         return;
623     var xml = xsearch.responseXML;
624     var error = xml.getElementsByTagName("error");
625     if (error[0])
626     {
627         var msg = error[0].childNodes[0].nodeValue;
628         alert(msg);
629         return;
630     }
631     check_search();
632     stattimer = setTimeout(check_stat, 1000);
633 }
634
635 function start_search()
636 {
637     clearTimeout(termtimer);
638     termtimer = 0;
639     clearTimeout(searchtimer);
640     searchtimer = 0;
641     clearTimeout(stattimer);
642     stattimer = 0;
643     clearTimeout(showtimer);
644     showtimer = 0;
645     cur_id = -1;
646     var query = escape(document.getElementById('query').value);
647     var url = "search.pz2?" +
648         "command=search" +
649         "&session=" + session +
650         "&query=" + query;
651     xsearch = GetXmlHttpObject();
652     xsearch.onreadystatechange=search_started;
653     xsearch.open("GET", url);
654     xsearch.send(null);
655     clear_cell(document.getElementById("body"));
656     update_history();
657     shown = 0;
658     document.search.startrec.value = 0;
659 }
660
661 function session_encode ()
662 {
663     var i;
664     var session = '';
665
666     for (i = 0; i < session_cells.length; i++)
667     {
668         var name = session_cells[i];
669         var value = escape(document.getElementById(name).value);
670         session += '&' + name + '=' + value;
671     }
672
673     return session;
674 }
675
676
677 function session_restore (session)
678 {
679     var fields = session.split(/&/);
680     var i;
681
682     for (i = 1; i < fields.length; i++)
683     {
684         var pair = fields[i].split(/=/);
685         var key = pair.shift();
686         var value = pair.join('=');
687         var cell = document.getElementById(key);
688
689         cell.value = value;
690     }
691     
692 }
693
694
695 function session_read ()
696 {
697     var ses = window.location.hash.replace(/^#/, '');
698     return ses;
699 }
700
701
702 function session_store (new_value)
703 {
704     window.location.hash = '#' + new_value;
705 }
706
707
708 function update_history ()
709 {
710     var session = session_encode();
711     session_store(session);
712     old_session = session;
713 }
714
715
716 function session_check ()
717 {
718     var session = session_read();
719     var action = document.search.action_type.value;
720
721     clearInterval(url_surveillence);
722
723     if ( session != unescape(old_session) )
724     {
725         session_restore(session);
726
727         if (action == 'search') {
728             start_search();
729         } else if (action == 'page') {
730             check_search();
731         } else {
732             alert('Unregocnized action_type: ' + action);
733             return;
734         }
735     }
736     
737     url_surveillence = setInterval(session_check, 200);
738 }
739
740
741 function get_available_facets () {
742     var facet_container = document.getElementById('termlists');
743     var facet_cells = facet_container.childNodes;
744     var facets = Array();
745     var i;
746
747     for (i = 0; i < facet_cells.length; i++) {
748         var cell = facet_cells.item(i);
749
750         if (cell.className == 'facet') {
751             var facet_name = cell.id.replace(/^facet_([^_]+)_terms$/, "$1");
752             facets.push(Array(facet_name, cell));
753         }
754     }
755
756     return facets;
757 }
758
759
760 function get_facet_container (obj) {
761     return document.getElementById(obj.id + '_terms');
762 }
763
764
765 function toggle_facet (obj) {
766     var container = get_facet_container(obj);
767
768     if (obj.className == 'selected') {
769         obj.className = 'unselected';
770         container.style.display = 'inline';
771     } else {
772         obj.className = 'selected';
773         container.style.display = 'none';
774     }
775 }