e6917a7e76e2a95d80abf8b194a3acef4029ab86
[pazpar2-moved-to-github.git] / www / demo / search.js
1 /* $Id: search.js,v 1.23 2007-01-15 04:34: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 mk = hits[i].getElementsByTagName("md-title");
260             var field = '';
261
262             if (mk[0]) {
263                 field = mk[0].childNodes[0].nodeValue;
264             } else {
265                 field = 'N/A';
266             }
267             
268             var record_cell = create_element('a', field);
269             record_cell.setAttribute('href', '#');
270             record_cell.className = 'record';
271             record_container.appendChild(record_cell);
272         }
273
274         shown++;
275         if (clients > 0)
276         {
277             if (shown < 5)
278                 searchtimer = setTimeout(check_search, 1000);
279             else
280                 searchtimer = setTimeout(check_search, 2000);
281         }
282     }
283     if (!termtimer)
284         termtimer = setTimeout(check_termlist, 500);
285 }
286
287 function check_search()
288 {
289     clearTimeout(searchtimer);
290     var url = "search.pz2?" +
291         "command=show" +
292         "&start=" + document.search.startrec.value +
293         "&num=" + recstoshow +
294         "&session=" + session +
295         "&sort=" + cur_sort +
296         "&block=1";
297     xshow = GetXmlHttpObject();
298     xshow.onreadystatechange=show_records;
299     xshow.open("GET", url);
300     xshow.send(null);
301 }
302
303
304 function refine_query (obj) {
305     var term = obj.getAttribute('term');
306     var cur_termlist = obj.getAttribute('facet');
307     var query_cell = document.getElementById('query');
308     
309     term = term.replace(/[\(\)]/g, '');
310     
311     if (cur_termlist == 'subject')
312         query_cell.value += ' and su=(' + term + ')';
313     else if (cur_termlist == 'author')
314         query_cell.value += ' and au=(' + term + ')';
315
316     start_search();
317 }
318
319
320
321 function show_termlist()
322 {
323     if (xtermlist.readyState != 4)
324         return;
325
326     var i;
327     var xml = xtermlist.responseXML;
328     var body = facet_list[cur_facet][1];
329     var facet_name = facet_list[cur_facet][0];
330     var hits = xml.getElementsByTagName("term");
331     var clients =
332         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
333
334     cur_facet++;
335
336     if (cur_facet >= facet_list.length)
337         cur_facet = 0;
338
339     if (!hits[0])
340     {
341         termtimer = setTimeout(check_termlist, 500);
342     }
343     else
344     {
345         clear_cell(body);
346         
347         for (i = 0; i < hits.length; i++)
348         {
349             var namen = hits[i].getElementsByTagName("name");
350             if (namen[0])
351                 var term = namen[0].childNodes[0].nodeValue;
352                 var refine_cell = create_element('a', term);
353                 refine_cell.setAttribute('href', '#');
354                 refine_cell.setAttribute('term', term);
355                 refine_cell.setAttribute('facet', facet_name);
356                 refine_cell.onclick = function () {
357                     refine_query(this);
358                     return false;
359                 };
360                 body.appendChild(refine_cell);
361         }
362
363         if (clients > 0)
364             termtimer = setTimeout(check_termlist, 1000);
365     }
366 }
367
368 function check_termlist()
369 {
370     var facet_name = facet_list[cur_facet][0];
371     var url = "search.pz2?" +
372         "command=termlist" +
373         "&session=" + session +
374         "&name=" + facet_name;
375     xtermlist = GetXmlHttpObject();
376     xtermlist.onreadystatechange=show_termlist;
377     xtermlist.open("GET", url);
378     xtermlist.send(null);
379 }
380
381 function show_stat()
382 {
383     if (xstat.readyState != 4)
384         return;
385     var i;
386     var xml = xstat.responseXML;
387     var body = document.getElementById("stat");
388     var nodes = xml.childNodes[0].childNodes;
389     var clients =
390         Number(xml.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue);
391     if (!nodes[0])
392     {
393         stattimer  = setTimeout(check_stat, 500);
394     }
395     else
396     {
397         assign_text(body, '(');
398         for (i = 0; i < nodes.length; i++)
399         {
400             if (nodes[i].nodeType != 1)
401                 continue;
402             var value = nodes[i].childNodes[0].nodeValue;
403             if (value == 0)
404                 continue;
405             var name = nodes[i].nodeName;
406             append_text(body, ' ' + name + '=' + value);
407         }
408
409         append_text(body, ')');
410         if (clients > 0)
411             stattimer = setTimeout(check_stat, 2000);
412     }
413 }
414
415 function check_stat()
416 {
417     var url = "search.pz2?" +
418         "command=stat" +
419         "&session=" + session;
420     xstat = GetXmlHttpObject();
421     xstat.onreadystatechange=show_stat;
422     xstat.open("GET", url);
423     xstat.send(null);
424 }
425
426 function search_started()
427 {
428     if (xsearch.readyState != 4)
429         return;
430     var xml = xsearch.responseXML;
431     var error = xml.getElementsByTagName("error");
432     if (error[0])
433     {
434         var msg = error[0].childNodes[0].nodeValue;
435         alert(msg);
436         return;
437     }
438     check_search();
439     stattimer = setTimeout(check_stat, 1000);
440 }
441
442 function start_search()
443 {
444     clearTimeout(termtimer);
445     termtimer = 0;
446     clearTimeout(searchtimer);
447     searchtimer = 0;
448     clearTimeout(stattimer);
449     stattimer = 0;
450     clearTimeout(showtimer);
451     showtimer = 0;
452     var query = escape(document.getElementById('query').value);
453     var url = "search.pz2?" +
454         "command=search" +
455         "&session=" + session +
456         "&query=" + query;
457     xsearch = GetXmlHttpObject();
458     xsearch.onreadystatechange=search_started;
459     xsearch.open("GET", url);
460     xsearch.send(null);
461     clear_cell(document.getElementById("body"));
462     update_history();
463     shown = 0;
464     document.search.startrec.value = 0;
465 }
466
467 function session_encode ()
468 {
469     var i;
470     var session = '';
471
472     for (i = 0; i < session_cells.length; i++)
473     {
474         var name = session_cells[i];
475         var value = escape(document.getElementById(name).value);
476         session += '&' + name + '=' + value;
477     }
478
479     return session;
480 }
481
482
483 function session_restore (session)
484 {
485     var fields = session.split(/&/);
486     var i;
487
488     for (i = 1; i < fields.length; i++)
489     {
490         var pair = fields[i].split(/=/);
491         var key = pair.shift();
492         var value = pair.join('=');
493         var cell = document.getElementById(key);
494
495         cell.value = value;
496     }
497     
498 }
499
500
501 function session_read ()
502 {
503     var ses = window.location.hash.replace(/^#/, '');
504     return ses;
505 }
506
507
508 function session_store (new_value)
509 {
510     window.location.hash = '#' + new_value;
511 }
512
513
514 function update_history ()
515 {
516     var session = session_encode();
517     session_store(session);
518     old_session = session;
519 }
520
521
522 function session_check ()
523 {
524     var session = session_read();
525     var action = document.search.action_type.value;
526
527     clearInterval(url_surveillence);
528
529     if ( session != unescape(old_session) )
530     {
531         session_restore(session);
532
533         if (action == 'search') {
534             start_search();
535         } else if (action == 'page') {
536             check_search();
537         } else {
538             alert('Unregocnized action_type: ' + action);
539             return;
540         }
541     }
542     
543     url_surveillence = setInterval(session_check, 200);
544 }
545
546
547 function get_available_facets () {
548     var facet_container = document.getElementById('termlists');
549     var facet_cells = facet_container.childNodes;
550     var facets = Array();
551     var i;
552
553     for (i = 0; i < facet_cells.length; i++) {
554         var cell = facet_cells.item(i);
555
556         if (cell.className == 'facet') {
557             var facet_name = cell.id.replace(/^facet_([^_]+)_terms$/, "$1");
558             facets.push(Array(facet_name, cell));
559         }
560     }
561
562     return facets;
563 }
564
565
566 function get_facet_container (obj) {
567     return document.getElementById(obj.id + '_terms');
568 }
569
570
571 function toggle_facet (obj) {
572     var container = get_facet_container(obj);
573
574     if (obj.className == 'selected') {
575         obj.className = 'unselected';
576         container.style.display = 'inline';
577     } else {
578         obj.className = 'selected';
579         container.style.display = 'none';
580     }
581 }