www/demo/search.js

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