experiments/spclient/mkws.js

   1 /* A very simple client that shows a basic usage of the pz2.js
   2 */
   3
   4 "use strict"; // HTML5
   5
   6 if (!mkws_config)
   7     var mkws_config = {}; // for the guys who forgot to define mkws_config...
   8
   9 var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
  10 var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "/service-proxy/";
  11
  12 var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
  13 var usesessions = mkws_config.use_service_proxy ? false : true;
  14
  15 var mkws_debug = 1;
  16
  17 var mkws_locale_lang = {
  18     "de": {
  19         "Authors": "Autoren",
  20         "Subjects": "Schlagw&ouml;rter",
  21         "Sources": "Daten und Quellen",
  22         "TERMLISTS": "Termlisten",
  23         "Next": "Weiter",
  24         "Prev": "Zur&uuml;ck",
  25         "Search": "Suche",
  26         "Sort by": "Sortieren nach",
  27         "and show": "und zeige",
  28         "per page": "pro Seite",
  29         "Displaying": "Zeige",
  30         "to": "von",
  31         "of": "aus",
  32         "found": "gefunden",
  33
  34         "dummy": "dummy"
  35     },
  36
  37     "da": {
  38         "Authors": "Forfattere",
  39         "Subjects": "Emner",
  40         "Sources": "Kilder",
  41         "TERMLISTS": "TERMLISTS",
  42         "Next": "N&aelig;ste",
  43         "Prev": "Forrige",
  44         "Search": "S&oslash;g",
  45         "Sort by": "Sorter efter",
  46         "and show": "og vis",
  47         "per page": "per side",
  48         "Displaying": "Viser",
  49         "to": "til",
  50         "of": "ud af",
  51         "found": "fandt",
  52
  53         "dummy": "dummy"
  54     }
  55 };
  56
  57 // create a parameters array and pass it to the pz2's constructor
  58 // then register the form submit event with the pz2.search function
  59 // autoInit is set to true on default
  60 var my_paz = new pz2( { "onshow": my_onshow,
  61                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
  62                     "pazpar2path": pazpar2path,
  63                     "oninit": my_oninit,
  64                     "onstat": my_onstat,
  65                     "onterm": my_onterm,
  66                     "termlist": "xtargets,subject,author",
  67                     "onbytarget": my_onbytarget,
  68                     "usesessions" : usesessions,
  69                     "showResponseType": '', // or "json" (for debugging?)
  70                     "onrecord": my_onrecord } );
  71 // some state vars
  72 var curPage = 1;
  73 var recPerPage = 20;
  74 var totalRec = 0;
  75 var curDetRecId = '';
  76 var curDetRecData = null;
  77 var curSort = 'relevance';
  78 var curFilter = null;
  79 var submitted = false;
  80 var SourceMax = 16;
  81 var SubjectMax = 10;
  82 var AuthorMax = 10;
  83
  84 //
  85 // pz2.js event handlers:
  86 //
  87 function my_oninit() {
  88     my_paz.stat();
  89     my_paz.bytarget();
  90 }
  91
  92 function my_onshow(data) {
  93     totalRec = data.merged;
  94     // move it out
  95     var pager = document.getElementById("pager");
  96     pager.innerHTML = "";
  97     pager.innerHTML +='<hr/><div style="float: right">' + M('Displaying') + ': '
  98                     + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
  99                      ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
 100                      + data.total + ')</div>';
 101     drawPager(pager);
 102     // navi
 103     var results = document.getElementById("results");
 104
 105     var html = [];
 106     for (var i = 0; i < data.hits.length; i++) {
 107         var hit = data.hits[i];
 108               html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
 109             +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
 110             +'<a href="#" id="rec_'+hit.recid
 111             +'" onclick="showDetails(this.id);return false;"><b>'
 112             + hit["md-title"] +' </b></a>');
 113               if (hit["md-title-remainder"] !== undefined) {
 114                 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
 115               }
 116               if (hit["md-title-responsibility"] !== undefined) {
 117             html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
 118         }
 119         if (hit.recid == curDetRecId) {
 120             html.push(renderDetails(curDetRecData));
 121         }
 122         html.push('</div>');
 123     }
 124     replaceHtml(results, html.join(''));
 125 }
 126
 127 function my_onstat(data) {
 128     var stat = document.getElementById("mkwsStat");
 129     if (stat == null)
 130         return;
 131
 132     stat.innerHTML = '<b>STATUS INFO</b> -- Active clients: '
 133                         + data.activeclients
 134                         + '/' + data.clients + ' -- </span>'
 135                         + '<span>Retrieved records: ' + data.records
 136                         + '/' + data.hits + ' :.</span>';
 137 }
 138
 139 function my_onterm(data) {
 140     var termlists = [];
 141     termlists.push('<hr/><b>' + M('TERMLISTS') + ':</b><hr/><div class="termtitle">' + M('Sources') + '</div>');
 142     for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
 143         termlists.push('<a href="#" target_id='+data.xtargets[i].id
 144             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
 145         + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
 146     }
 147
 148     termlists.push('<hr/><div class="termtitle">' + M('Subjects') + '</div>');
 149     for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
 150         termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span>  ('
 151               + data.subject[i].freq + ')</span><br/>');
 152     }
 153
 154     termlists.push('<hr/><div class="termtitle">' + M('Authors') + '</div>');
 155     for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
 156         termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
 157                             + data.author[i].name
 158                             + ' </a><span> ('
 159                             + data.author[i].freq
 160                             + ')</span><br/>');
 161     }
 162     var termlist = document.getElementById("termlist");
 163     replaceHtml(termlist, termlists.join(''));
 164 }
 165
 166 function my_onrecord(data) {
 167     // FIXME: record is async!!
 168     clearTimeout(my_paz.recordTimer);
 169     // in case on_show was faster to redraw element
 170     var detRecordDiv = document.getElementById('det_'+data.recid);
 171     if (detRecordDiv) return;
 172     curDetRecData = data;
 173     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
 174     var html = renderDetails(curDetRecData);
 175     recordDiv.innerHTML += html;
 176 }
 177
 178 function my_onbytarget(data) {
 179     var targetDiv = document.getElementById("bytarget");
 180     var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
 181         +'<td>Records</td><td>State</td></tr></thead><tbody>';
 182
 183     for (var i = 0; i < data.length; i++ ) {
 184         table += "<tr><td>" + data[i].id +
 185             "</td><td>" + data[i].hits +
 186             "</td><td>" + data[i].diagnostic +
 187             "</td><td>" + data[i].records +
 188             "</td><td>" + data[i].state + "</td></tr>";
 189     }
 190
 191     table += '</tbody></table>';
 192     targetDiv.innerHTML = table;
 193 }
 194
 195 ////////////////////////////////////////////////////////////////////////////////
 196 ////////////////////////////////////////////////////////////////////////////////
 197
 198 // wait until the DOM is ready
 199 function domReady ()
 200 {
 201     document.search.onsubmit = onFormSubmitEventHandler;
 202     document.search.query.value = '';
 203     document.select.sort.onchange = onSelectDdChange;
 204     document.select.perpage.onchange = onSelectDdChange;
 205 }
 206
 207 // when search button pressed
 208 function onFormSubmitEventHandler()
 209 {
 210     resetPage();
 211     loadSelect();
 212     triggerSearch();
 213     submitted = true;
 214     return false;
 215 }
 216
 217 function onSelectDdChange()
 218 {
 219     if (!submitted) return false;
 220     resetPage();
 221     loadSelect();
 222     my_paz.show(0, recPerPage, curSort);
 223     return false;
 224 }
 225
 226 function resetPage()
 227 {
 228     curPage = 1;
 229     totalRec = 0;
 230 }
 231
 232 function triggerSearch ()
 233 {
 234     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
 235 }
 236
 237 function loadSelect ()
 238 {
 239     curSort = document.select.sort.value;
 240     recPerPage = document.select.perpage.value;
 241 }
 242
 243 // limit the query after clicking the facet
 244 function limitQuery (field, value)
 245 {
 246     document.search.query.value += ' and ' + field + '="' + value + '"';
 247     onFormSubmitEventHandler();
 248 }
 249
 250 // limit by target functions
 251 function limitTarget (id, name)
 252 {
 253     var navi = document.getElementById('navi');
 254     navi.innerHTML =
 255         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
 256         + name + '</a>';
 257     navi.innerHTML += '<hr/>';
 258     curFilter = 'pz:id=' + id;
 259     resetPage();
 260     loadSelect();
 261     triggerSearch();
 262     return false;
 263 }
 264
 265 function delimitTarget ()
 266 {
 267     var navi = document.getElementById('navi');
 268     navi.innerHTML = '';
 269     curFilter = null;
 270     resetPage();
 271     loadSelect();
 272     triggerSearch();
 273     return false;
 274 }
 275
 276 function drawPager (pagerDiv)
 277 {
 278     //client indexes pages from 1 but pz2 from 0
 279     var onsides = 6;
 280     var pages = Math.ceil(totalRec / recPerPage);
 281
 282     var firstClkbl = ( curPage - onsides > 0 )
 283         ? curPage - onsides
 284         : 1;
 285
 286     var lastClkbl = firstClkbl + 2*onsides < pages
 287         ? firstClkbl + 2*onsides
 288         : pages;
 289
 290     var prev = '<span id="prev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
 291     if (curPage > 1)
 292         prev = '<a href="#" id="prev" onclick="pagerPrev();">'
 293         +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
 294
 295     var middle = '';
 296     for(var i = firstClkbl; i <= lastClkbl; i++) {
 297         var numLabel = i;
 298         if(i == curPage)
 299             numLabel = '<b>' + i + '</b>';
 300
 301         middle += '<a href="#" onclick="showPage(' + i + ')"> '
 302             + numLabel + ' </a>';
 303     }
 304
 305     var next = '<b> | </b><span id="next">' + M('Next') + ' &#62;&#62;</span>';
 306     if (pages - curPage > 0)
 307         next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
 308         + M('Next') + ' &#62;&#62;</a>';
 309
 310     var predots = '';
 311     if (firstClkbl > 1)
 312         predots = '...';
 313
 314     var postdots = '';
 315     if (lastClkbl < pages)
 316         postdots = '...';
 317
 318     pagerDiv.innerHTML += '<div style="float: clear">'
 319         + prev + predots + middle + postdots + next + '</div><hr/>';
 320 }
 321
 322 function showPage (pageNum)
 323 {
 324     curPage = pageNum;
 325     my_paz.showPage( curPage - 1 );
 326 }
 327
 328 // simple paging functions
 329
 330 function pagerNext() {
 331     if ( totalRec - recPerPage*curPage > 0) {
 332         my_paz.showNext();
 333         curPage++;
 334     }
 335 }
 336
 337 function pagerPrev() {
 338     if ( my_paz.showPrev() != false )
 339         curPage--;
 340 }
 341
 342 // swithing view between targets and records
 343
 344 function switchView(view) {
 345
 346     var targets = document.getElementById('mkwsTargets');
 347     var records = document.getElementById('mkwsRecords');
 348
 349     switch(view) {
 350         case 'targets':
 351             targets.style.display = "block";
 352             records.style.display = "none";
 353             break;
 354         case 'records':
 355             targets.style.display = "none";
 356             records.style.display = "block";
 357             break;
 358         default:
 359             alert('Unknown view.');
 360     }
 361 }
 362
 363 // detailed record drawing
 364 function showDetails (prefixRecId) {
 365     var recId = prefixRecId.replace('rec_', '');
 366     var oldRecId = curDetRecId;
 367     curDetRecId = recId;
 368
 369     // remove current detailed view if any
 370     var detRecordDiv = document.getElementById('det_'+oldRecId);
 371     // lovin DOM!
 372     if (detRecordDiv)
 373       detRecordDiv.parentNode.removeChild(detRecordDiv);
 374
 375     // if the same clicked, just hide
 376     if (recId == oldRecId) {
 377         curDetRecId = '';
 378         curDetRecData = null;
 379         return;
 380     }
 381     // request the record
 382     my_paz.record(recId);
 383 }
 384
 385 function replaceHtml(el, html) {
 386   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
 387   /*@cc_on // Pure innerHTML is slightly faster in IE
 388     oldEl.innerHTML = html;
 389     return oldEl;
 390     @*/
 391   var newEl = oldEl.cloneNode(false);
 392   newEl.innerHTML = html;
 393   oldEl.parentNode.replaceChild(newEl, oldEl);
 394   /* Since we just removed the old element from the DOM, return a reference
 395      to the new element, which can be used to restore variable references. */
 396   return newEl;
 397 };
 398
 399 function renderDetails(data, marker)
 400 {
 401     var details = '<div class="details" id="det_'+data.recid+'"><table>';
 402     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
 403     if (data["md-title"] != undefined) {
 404         details += '<tr><td><b>Title</b></td><td><b>:</b> '+data["md-title"];
 405         if (data["md-title-remainder"] !== undefined) {
 406               details += ' : <span>' + data["md-title-remainder"] + ' </span>';
 407         }
 408         if (data["md-title-responsibility"] !== undefined) {
 409               details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
 410         }
 411           details += '</td></tr>';
 412     }
 413     if (data["md-date"] != undefined)
 414         details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
 415     if (data["md-author"] != undefined)
 416         details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
 417     if (data["md-electronic-url"] != undefined)
 418         details += '<tr><td><b>URL</b></td><td><b>:</b> <a href="' + data["md-electronic-url"] + '" target="_blank">' + data["md-electronic-url"] + '</a>' + '</td></tr>';
 419     if (data["location"][0]["md-subject"] != undefined)
 420         details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
 421     if (data["location"][0]["@name"] != undefined)
 422         details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
 423     details += '</table></div>';
 424     return details;
 425 }
 426
 427 /*
 428  * All the HTML stuff to render the search forms and
 429  * result pages.
 430  */
 431 function mkws_html_all(data) {
 432
 433     /* default config */
 434     var config = {
 435         sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
 436         perpage: [10, 20, 30, 50],
 437         sort_default: "relevance",
 438         perpage_default: 20,
 439         query_width: 50,
 440         switch_menu: true, /* show/hide Records|Targets menu */
 441         debug: 0,     /* debug level for development: 0..2 */
 442
 443         dummy: "dummy"
 444     };
 445
 446     /* set global debug flag early */
 447     if (data.debug !== 'undefined') {
 448         mkws_debug = data.debug;
 449     } else if (config.debug !== 'undefined') {
 450         mkws_debug = config.debug;
 451     }
 452
 453     /* override standard config values by function parameters */
 454     for (var k in data) {
 455         config[k] = data[k];
 456         debug("Set config: " + k + ' => ' + data[k]);
 457     }
 458
 459     mkws_set_lang(mkws_config);
 460     mkws_html_lang(mkws_config);
 461
 462     // For some reason, doing this programmatically results in
 463     // document.search.query being undefined, hence the raw HTML.
 464     debug("HTML search form");
 465     $("#mkwsSearch").html('\
 466     <form id="searchForm" name="search" action="" >\
 467       <input id="query" type="text" size="50" />\
 468       <input id="button" type="submit" value="' + M('Search') + '" />\
 469     </form>');
 470
 471     debug("HTML records");
 472     $("#mkwsRecords").html('\
 473       <table width="100%" border="0" cellpadding="6" cellspacing="0">\
 474         <tr>\
 475           <td width="250" valign="top">\
 476             <div id="termlist"></div>\
 477           </td>\
 478           <td valign="top">\
 479             <div id="ranking">\
 480               <form name="select" id="select" action="" >\
 481         ' + M('Sort by') + mkws_html_sort(config) + '\
 482         ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
 483         ' + M('per page') + '.\
 484        </form>\
 485             </div>\
 486             <div id="pager"></div>\
 487             <div id="navi"></div>\
 488             <div id="results"></div>\
 489           </td>\
 490         </tr>\
 491       </table>\
 492     </div>');
 493
 494     mkws_html_switch(config);
 495     if (mkws_config.use_service_proxy)
 496         mkws_service_proxy_auth(config.service_proxy_auth);
 497
 498     domReady();
 499 }
 500
 501 function mkws_set_lang(mkws_config)  {
 502     var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
 503     if (!lang || !mkws_locale_lang[lang]) {
 504         mkws_config.lang = ""
 505     } else {
 506         mkws_config.lang = lang;
 507     }
 508
 509     debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
 510     return mkws_config.lang;
 511 }
 512
 513 function mkws_html_switch(config) {
 514     debug("HTML switch");
 515
 516     $("#mkwsSwitch").html($("<a/>", {
 517         href: '#',
 518         onclick: "switchView(\'records\')",
 519         text: "Records"
 520     }));
 521     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
 522     $("#mkwsSwitch").append($("<a/>", {
 523         href: '#',
 524         onclick: "switchView(\'targets\')",
 525         text: "Targets"
 526     }));
 527
 528     debug("HTML targets");
 529     $("#mkwsTargets").html('\
 530       <div id="bytarget">\
 531        No information available yet.\
 532       </div>');
 533     $("#mkwsTargets").css("display", "none");
 534
 535     if (!config.switch_menu) {
 536         debug("disable switch menu");
 537         $("#mkwsSwitch").css("display", "none");
 538     }
 539 }
 540
 541 function mkws_html_sort(config) {
 542     debug("HTML sort");
 543     var sort_html = '<select name="sort" id="sort">';
 544
 545     for(var i = 0; i < config.sort.length; i++) {
 546         var key = config.sort[i][0];
 547         var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
 548
 549         sort_html += '<option value="' + key + '"';
 550         if (key == config.sort_default) {
 551             sort_html += ' selected="selected"';
 552         }
 553         sort_html += '>' + val + '</option>';
 554     }
 555     sort_html += '</select>';
 556
 557     return sort_html;
 558 }
 559
 560 function mkws_html_perpage(config) {
 561     debug("HTML perpage");
 562     var perpage_html = '<select name="perpage" id="perpage">';
 563
 564     for(var i = 0; i < config.perpage.length; i++) {
 565         var key = config.perpage[i];
 566
 567         perpage_html += '<option value="' + key + '"';
 568         if (key == config.perpage_default) {
 569             perpage_html += ' selected="selected"';
 570         }
 571         perpage_html += '>' + key + '</option>';
 572     }
 573     perpage_html += '</select>';
 574
 575     return perpage_html;
 576 }
 577
 578 /*
 579  * Run service-proxy authentication in background (after page load).
 580  * The username/password is configured in the apache config file
 581  * for the site.
 582  */
 583 function mkws_service_proxy_auth(auth_url) {
 584     if (!auth_url)
 585         auth_url = "/service-proxy-auth";
 586
 587     debug("Run service proxy auth URL: " + auth_url);
 588
 589     var jqxhr = jQuery.get(auth_url)
 590         .fail(function() {
 591             alert("service proxy authentication failed, give up!");
 592         })
 593         .success(function(data) {
 594             if (!jQuery.isXMLDoc(data)) {
 595                 alert("service proxy auth response document is not valid XML document, give up!");
 596                 return;
 597             }
 598             var status = $(data).find("status");
 599             if (status.text() != "OK") {
 600                 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
 601                 return;
 602             }
 603         });
 604 }
 605
 606 /* create locale language menu */
 607 function mkws_html_lang(mkws_config) {
 608     var lang_default = "en";
 609     var lang = mkws_config.lang || lang_default;
 610     var list = [lang_default];
 611
 612     for (var k in mkws_locale_lang) {
 613         list.push(k);
 614     }
 615     debug("Language menu for: " + list.join(", "));
 616
 617     var data = "";
 618     for(var i = 0; i < list.length; i++) {
 619         var l = list[i];
 620
 621         if (data)
 622             data += ' | ';
 623
 624         if (lang == l) {
 625             data += l;
 626         } else {
 627             data += ' <a href="/?lang=' + l + '">' + l + '</a> '
 628         }
 629     }
 630
 631     $("#mkwsLang").html(data);
 632 }
 633
 634 /* locale */
 635 function M(word) {
 636     var lang = mkws_config.lang;
 637
 638     if (!lang || !mkws_locale_lang[lang])
 639         return word;
 640
 641     return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
 642 }
 643
 644 /* implement jQuery.parseQuerystring() for parsing URL parameters */
 645 jQuery.extend({
 646     parseQuerystring: function() {
 647     var nvpair = {};
 648     var qs = window.location.search.replace('?', '');
 649     var pairs = qs.split('&');
 650     $.each(pairs, function(i, v){
 651         var pair = v.split('=');
 652         nvpair[pair[0]] = pair[1];
 653     });
 654     return nvpair;
 655 } });
 656
 657 function debug(string) {
 658     if (!mkws_debug)
 659         return;
 660
 661     var console; // IE8 quirks
 662     if (!console) { /* ARGH!!! */
 663         return;
 664     }
 665
 666     // you need to disable use strict at the top of the file!!!
 667     if (mkws_debug >= 3) {
 668         console.log(arguments.callee.caller);
 669     } else if (mkws_debug >= 2) {
 670         console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
 671     }
 672     console.log(string);
 673 }
 674
 675 /* magic */
 676 $(document).ready(function() { mkws_html_all(mkws_config) });