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