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