www/demo/search.js

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