Added author display
[pazpar2-moved-to-github.git] / www / demo / search.js
1 /* $Id: search.js,v 1.24 2007-01-15 19:01:29 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 session = false;
14 var targetsloaded = false;
15 var shown;
16 var searchtimer;
17 var showtimer;
18 var termtimer;
19 var stattimer;
20 var session_cells = Array('query', 'startrec', 'action_type');
21 var old_session = session_read();
22 var url_surveillence;
23 var recstoshow = 20;
24 var page_window = 5;  // Number of pages prior to and after the current page
25 var facet_list;
26 var cur_facet = 0;
27 var cur_sort = "relevance";
28 var searched = 0;
29
30 function initialize ()
31 {
32     facet_list = get_available_facets();
33     start_session();
34     session_check();
35     set_sort();
36 }
37
38
39 function GetXmlHttpObject()
40
41     var objXMLHttp=null
42     if (window.XMLHttpRequest)
43       {
44       objXMLHttp=new XMLHttpRequest()
45       }
46     else if (window.ActiveXObject)
47       {
48       objXMLHttp=new ActiveXObject("Microsoft.XMLHTTP")
49       }
50     return objXMLHttp
51
52
53 function SendXmlHttpObject(obj, url, handler)
54 {
55     obj.onreadystatechange=handler;
56     obj.open("GET", url);
57     obj.send(null);
58 }
59
60 function session_started()
61 {
62     if (xinitSession.readyState != 4)
63         return;
64     var xml = xinitSession.responseXML;
65     var sesid = xml.getElementsByTagName("session")[0].childNodes[0].nodeValue;
66     assign_text(document.getElementById("status"), 'Live');
67     session = sesid;
68     setTimeout(ping_session, 50000);
69 }
70
71 function start_session()
72 {
73     xinitSession = GetXmlHttpObject();
74     var url="search.pz2?";
75     url += "command=init";
76     xinitSession.onreadystatechange=session_started;
77     xinitSession.open("GET", url);
78     xinitSession.send(null);
79 }
80
81 function ping_session()
82 {
83     if (!session)
84         return;
85     var url = "search.pz2?command=ping&session=" + session;
86     SendXmlHttpObject(xpingSession = GetXmlHttpObject(), url, session_pinged);
87 }
88
89 function session_pinged()
90 {
91     if (xpingSession.readyState != 4)
92         return;
93     var xml = xpingSession.responseXML;
94     var error = xml.getElementsByTagName("error");
95     if (error[0])
96     {
97         var msg = error[0].childNodes[0].nodeValue;
98         alert(msg);
99         location = "?";
100         return;
101     }
102     setTimeout(ping_session, 50000);
103 }
104
105 function update_action (new_action) {
106     document.search.action_type.value = new_action;
107 }
108
109
110 function make_pager (hits, offset, max) {
111     var html = '';
112     var off;
113     var start_offset = offset - page_window * max;
114     var div_elem = document.createElement('div');
115     
116     div_elem.className = 'pages';
117
118     if (start_offset < 0) {
119         start_offset = 0;
120     }
121
122     for (off = start_offset;
123          off < hits && off < (start_offset + 2 * page_window * max); 
124          off += max) {
125         
126         var p = off / max + 1;
127         var page_elem = create_element('a', p);
128         var newline_node = document.createTextNode(' ');
129
130         if ((offset >= off) && (offset < (off + max))) {
131             page_elem.className = 'select';
132         }
133
134         page_elem.setAttribute('off', off);
135         page_elem.style.cursor = 'pointer';
136         page_elem.onclick = function () {
137             update_offset(this.getAttribute('off'));
138         };
139
140         div_elem.appendChild(page_elem);
141         div_elem.appendChild(newline_node);
142     }
143
144     return div_elem;
145 }
146
147
148 function update_offset (offset) {
149     clearTimeout(searchtimer);
150     document.search.startrec.value = offset;
151     update_action('page');
152     check_search();
153     update_history();
154     return false;
155 }
156
157
158 function create_element (name, cdata) {
159     var elem_node = document.createElement(name);
160     var text_node = document.createTextNode(cdata);
161     elem_node.appendChild(text_node);
162
163     return elem_node;
164 }
165
166
167 function clear_cell (cell) {
168     while (cell.hasChildNodes())
169         cell.removeChild(cell.firstChild);
170 }
171
172
173 function append_text(cell, text) {
174     text_node = document.createTextNode(text);
175     cell.appendChild(text_node);
176 }
177
178
179 function assign_text (cell, text) {
180     clear_cell(cell);
181     append_text(cell, text);
182 }
183
184 function set_sort_opt(n, opt, str)
185 {
186     var txt = document.createTextNode(str);
187     if (opt == cur_sort)
188         n.appendChild(txt);
189     else
190     {
191         var a = document.createElement('a');
192         a.appendChild(txt);
193         a.setAttribute('href', "");
194         a.setAttribute('onclick', "set_sort('" + opt + "'); return false");
195         n.appendChild(a);
196     }
197 }
198
199 function set_sort(sort)
200 {
201     if (sort && sort != cur_sort)
202     {
203         cur_sort = sort;
204         if (searched)
205             check_search();
206     }
207
208     var t = document.getElementById("sortselect");
209     clear_cell(t);
210     t.appendChild(document.createTextNode("Sort results by: "));
211     set_sort_opt(t, 'relevance', 'Relevance');
212     t.appendChild(document.createTextNode(" or "));
213     set_sort_opt(t, 'title:1', 'Title');
214 }
215
216 function show_records()
217 {
218     if (xshow.readyState != 4)
219         return;
220     var i;
221     var xml = xshow.responseXML;
222     var body = document.getElementById("body");
223     var hits = xml.getElementsByTagName("hit");
224
225     clear_cell(body);
226
227     if (!hits[0]) // We should never get here with blocking operations
228     {
229         assign_text(body, 'No records yet');
230         searchtimer = setTimeout(check_search, 250);
231     }
232     else
233     {
234         var total = Number(xml.getElementsByTagName('total')[0].childNodes[0].nodeValue);
235         var merged = Number(xml.getElementsByTagName('merged')[0].childNodes[0].nodeValue);
236         var start = Number(xml.getElementsByTagName('start')[0].childNodes[0].nodeValue);
237         var num = Number(xml.getElementsByTagName('num')[0].childNodes[0].nodeValue);
238         var clients = Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
239         var pager = make_pager(merged, start,recstoshow);
240         var break_node1 = document.createElement('br');
241         var break_node2 = document.createElement('br');
242         var record_container = document.createElement('div');
243         var interval = create_element('div', 'Records : ' + (start + 1) +
244                                              ' to ' + (start + num) + ' of ' +
245                                              merged + ' (total hits: ' +
246                                              total + ')');
247         searched = 1;
248         interval.className = 'results';
249         record_container.className = 'records';
250
251         body.appendChild(pager);
252         body.appendChild(interval);
253         body.appendChild(break_node1);
254         body.appendChild(break_node2);
255         body.appendChild(record_container);
256
257         for (i = 0; i < hits.length; i++)
258         {
259             var tn = hits[i].getElementsByTagName("md-title");
260             var title = '';
261             var an = hits[i].getElementsByTagName("md-author");
262             var author = '';
263
264             if (tn[0]) {
265                 title = tn[0].childNodes[0].nodeValue;
266             } else {
267                 title = 'N/A';
268             }
269             if (an[0])
270                     author = an[0].childNodes[0].nodeValue;
271             
272             var record_div = document.createElement('div');
273             record_div.className = 'record';
274
275             var record_cell = create_element('a', title);
276             record_cell.setAttribute('href', '#');
277             record_div.appendChild(record_cell);
278             if (author)
279             {
280                 record_div.appendChild(document.createTextNode(', by '));
281                 record_div.appendChild(document.createTextNode(author));
282             }
283             record_container.appendChild(record_div);
284         }
285
286         shown++;
287         if (clients > 0)
288         {
289             if (shown < 5)
290                 searchtimer = setTimeout(check_search, 1000);
291             else
292                 searchtimer = setTimeout(check_search, 2000);
293         }
294     }
295     if (!termtimer)
296         termtimer = setTimeout(check_termlist, 500);
297 }
298
299 function check_search()
300 {
301     clearTimeout(searchtimer);
302     var url = "search.pz2?" +
303         "command=show" +
304         "&start=" + document.search.startrec.value +
305         "&num=" + recstoshow +
306         "&session=" + session +
307         "&sort=" + cur_sort +
308         "&block=1";
309     xshow = GetXmlHttpObject();
310     xshow.onreadystatechange=show_records;
311     xshow.open("GET", url);
312     xshow.send(null);
313 }
314
315
316 function refine_query (obj) {
317     var term = obj.getAttribute('term');
318     var cur_termlist = obj.getAttribute('facet');
319     var query_cell = document.getElementById('query');
320     
321     term = term.replace(/[\(\)]/g, '');
322     
323     if (cur_termlist == 'subject')
324         query_cell.value += ' and su=(' + term + ')';
325     else if (cur_termlist == 'author')
326         query_cell.value += ' and au=(' + term + ')';
327
328     start_search();
329 }
330
331
332
333 function show_termlist()
334 {
335     if (xtermlist.readyState != 4)
336         return;
337
338     var i;
339     var xml = xtermlist.responseXML;
340     var body = facet_list[cur_facet][1];
341     var facet_name = facet_list[cur_facet][0];
342     var hits = xml.getElementsByTagName("term");
343     var clients =
344         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
345
346     cur_facet++;
347
348     if (cur_facet >= facet_list.length)
349         cur_facet = 0;
350
351     if (!hits[0])
352     {
353         termtimer = setTimeout(check_termlist, 500);
354     }
355     else
356     {
357         clear_cell(body);
358         
359         for (i = 0; i < hits.length; i++)
360         {
361             var namen = hits[i].getElementsByTagName("name");
362             if (namen[0])
363                 var term = namen[0].childNodes[0].nodeValue;
364                 var refine_cell = create_element('a', term);
365                 refine_cell.setAttribute('href', '#');
366                 refine_cell.setAttribute('term', term);
367                 refine_cell.setAttribute('facet', facet_name);
368                 refine_cell.onclick = function () {
369                     refine_query(this);
370                     return false;
371                 };
372                 body.appendChild(refine_cell);
373         }
374
375         if (clients > 0)
376             termtimer = setTimeout(check_termlist, 1000);
377     }
378 }
379
380 function check_termlist()
381 {
382     var facet_name = facet_list[cur_facet][0];
383     var url = "search.pz2?" +
384         "command=termlist" +
385         "&session=" + session +
386         "&name=" + facet_name;
387     xtermlist = GetXmlHttpObject();
388     xtermlist.onreadystatechange=show_termlist;
389     xtermlist.open("GET", url);
390     xtermlist.send(null);
391 }
392
393 function show_stat()
394 {
395     if (xstat.readyState != 4)
396         return;
397     var i;
398     var xml = xstat.responseXML;
399     var body = document.getElementById("stat");
400     var nodes = xml.childNodes[0].childNodes;
401     var clients =
402         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
403     if (!nodes[0])
404     {
405         stattimer  = setTimeout(check_stat, 500);
406     }
407     else
408     {
409         assign_text(body, '(');
410         for (i = 0; i < nodes.length; i++)
411         {
412             if (nodes[i].nodeType != 1)
413                 continue;
414             var value = nodes[i].childNodes[0].nodeValue;
415             if (value == 0)
416                 continue;
417             var name = nodes[i].nodeName;
418             append_text(body, ' ' + name + '=' + value);
419         }
420
421         append_text(body, ')');
422         if (clients > 0)
423             stattimer = setTimeout(check_stat, 2000);
424     }
425 }
426
427 function check_stat()
428 {
429     var url = "search.pz2?" +
430         "command=stat" +
431         "&session=" + session;
432     xstat = GetXmlHttpObject();
433     xstat.onreadystatechange=show_stat;
434     xstat.open("GET", url);
435     xstat.send(null);
436 }
437
438 function search_started()
439 {
440     if (xsearch.readyState != 4)
441         return;
442     var xml = xsearch.responseXML;
443     var error = xml.getElementsByTagName("error");
444     if (error[0])
445     {
446         var msg = error[0].childNodes[0].nodeValue;
447         alert(msg);
448         return;
449     }
450     check_search();
451     stattimer = setTimeout(check_stat, 1000);
452 }
453
454 function start_search()
455 {
456     clearTimeout(termtimer);
457     termtimer = 0;
458     clearTimeout(searchtimer);
459     searchtimer = 0;
460     clearTimeout(stattimer);
461     stattimer = 0;
462     clearTimeout(showtimer);
463     showtimer = 0;
464     var query = escape(document.getElementById('query').value);
465     var url = "search.pz2?" +
466         "command=search" +
467         "&session=" + session +
468         "&query=" + query;
469     xsearch = GetXmlHttpObject();
470     xsearch.onreadystatechange=search_started;
471     xsearch.open("GET", url);
472     xsearch.send(null);
473     clear_cell(document.getElementById("body"));
474     update_history();
475     shown = 0;
476     document.search.startrec.value = 0;
477 }
478
479 function session_encode ()
480 {
481     var i;
482     var session = '';
483
484     for (i = 0; i < session_cells.length; i++)
485     {
486         var name = session_cells[i];
487         var value = escape(document.getElementById(name).value);
488         session += '&' + name + '=' + value;
489     }
490
491     return session;
492 }
493
494
495 function session_restore (session)
496 {
497     var fields = session.split(/&/);
498     var i;
499
500     for (i = 1; i < fields.length; i++)
501     {
502         var pair = fields[i].split(/=/);
503         var key = pair.shift();
504         var value = pair.join('=');
505         var cell = document.getElementById(key);
506
507         cell.value = value;
508     }
509     
510 }
511
512
513 function session_read ()
514 {
515     var ses = window.location.hash.replace(/^#/, '');
516     return ses;
517 }
518
519
520 function session_store (new_value)
521 {
522     window.location.hash = '#' + new_value;
523 }
524
525
526 function update_history ()
527 {
528     var session = session_encode();
529     session_store(session);
530     old_session = session;
531 }
532
533
534 function session_check ()
535 {
536     var session = session_read();
537     var action = document.search.action_type.value;
538
539     clearInterval(url_surveillence);
540
541     if ( session != unescape(old_session) )
542     {
543         session_restore(session);
544
545         if (action == 'search') {
546             start_search();
547         } else if (action == 'page') {
548             check_search();
549         } else {
550             alert('Unregocnized action_type: ' + action);
551             return;
552         }
553     }
554     
555     url_surveillence = setInterval(session_check, 200);
556 }
557
558
559 function get_available_facets () {
560     var facet_container = document.getElementById('termlists');
561     var facet_cells = facet_container.childNodes;
562     var facets = Array();
563     var i;
564
565     for (i = 0; i < facet_cells.length; i++) {
566         var cell = facet_cells.item(i);
567
568         if (cell.className == 'facet') {
569             var facet_name = cell.id.replace(/^facet_([^_]+)_terms$/, "$1");
570             facets.push(Array(facet_name, cell));
571         }
572     }
573
574     return facets;
575 }
576
577
578 function get_facet_container (obj) {
579     return document.getElementById(obj.id + '_terms');
580 }
581
582
583 function toggle_facet (obj) {
584     var container = get_facet_container(obj);
585
586     if (obj.className == 'selected') {
587         obj.className = 'unselected';
588         container.style.display = 'inline';
589     } else {
590         obj.className = 'selected';
591         container.style.display = 'none';
592     }
593 }