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 // create a parameters array and pass it to the pz2's constructor
  16 // then register the form submit event with the pz2.search function
  17 // autoInit is set to true on default
  18 var my_paz = new pz2( { "onshow": my_onshow,
  19                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
  20                     "pazpar2path": pazpar2path,
  21                     "oninit": my_oninit,
  22                     "onstat": my_onstat,
  23                     "onterm": my_onterm,
  24                     "termlist": "xtargets,subject,author",
  25                     "onbytarget": my_onbytarget,
  26                     "usesessions" : usesessions,
  27                     "showResponseType": '', // or "json" (for debugging?)
  28                     "onrecord": my_onrecord } );
  29 // some state vars
  30 var curPage = 1;
  31 var recPerPage = 20;
  32 var totalRec = 0;
  33 var curDetRecId = '';
  34 var curDetRecData = null;
  35 var curSort = 'relevance';
  36 var curFilter = null;
  37 var submitted = false;
  38 var SourceMax = 16;
  39 var SubjectMax = 10;
  40 var AuthorMax = 10;
  41
  42 //
  43 // pz2.js event handlers:
  44 //
  45 function my_oninit() {
  46     my_paz.stat();
  47     my_paz.bytarget();
  48 }
  49
  50 function my_onshow(data) {
  51     totalRec = data.merged;
  52     // move it out
  53     var pager = document.getElementById("pager");
  54     pager.innerHTML = "";
  55     pager.innerHTML +='<hr/><div style="float: right">Displaying: '
  56                     + (data.start + 1) + ' to ' + (data.start + data.num) +
  57                      ' of ' + data.merged + ' (found: '
  58                      + data.total + ')</div>';
  59     drawPager(pager);
  60     // navi
  61     var results = document.getElementById("results");
  62
  63     var html = [];
  64     for (var i = 0; i < data.hits.length; i++) {
  65         var hit = data.hits[i];
  66               html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
  67             +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
  68             +'<a href="#" id="rec_'+hit.recid
  69             +'" onclick="showDetails(this.id);return false;"><b>'
  70             + hit["md-title"] +' </b></a>');
  71               if (hit["md-title-remainder"] !== undefined) {
  72                 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
  73               }
  74               if (hit["md-title-responsibility"] !== undefined) {
  75             html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
  76         }
  77         if (hit.recid == curDetRecId) {
  78             html.push(renderDetails(curDetRecData));
  79         }
  80         html.push('</div>');
  81     }
  82     replaceHtml(results, html.join(''));
  83 }
  84
  85 function my_onstat(data) {
  86     var stat = document.getElementById("mkwsStat");
  87     if (stat == null)
  88         return;
  89
  90     stat.innerHTML = '<b>STATUS INFO</b> -- Active clients: '
  91                         + data.activeclients
  92                         + '/' + data.clients + ' -- </span>'
  93                         + '<span>Retrieved records: ' + data.records
  94                         + '/' + data.hits + ' :.</span>';
  95 }
  96
  97 function my_onterm(data) {
  98     var termlists = [];
  99     termlists.push('<hr/><b>TERMLISTS:</b><hr/><div class="termtitle">Sources</div>');
 100     for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
 101         termlists.push('<a href="#" target_id='+data.xtargets[i].id
 102             + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
 103         + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
 104     }
 105
 106     termlists.push('<hr/><div class="termtitle">Subjects</div>');
 107     for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
 108         termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span>  ('
 109               + data.subject[i].freq + ')</span><br/>');
 110     }
 111
 112     termlists.push('<hr/><div class="termtitle">Authors</div>');
 113     for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
 114         termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
 115                             + data.author[i].name
 116                             + ' </a><span> ('
 117                             + data.author[i].freq
 118                             + ')</span><br/>');
 119     }
 120     var termlist = document.getElementById("termlist");
 121     replaceHtml(termlist, termlists.join(''));
 122 }
 123
 124 function my_onrecord(data) {
 125     // FIXME: record is async!!
 126     clearTimeout(my_paz.recordTimer);
 127     // in case on_show was faster to redraw element
 128     var detRecordDiv = document.getElementById('det_'+data.recid);
 129     if (detRecordDiv) return;
 130     curDetRecData = data;
 131     var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
 132     var html = renderDetails(curDetRecData);
 133     recordDiv.innerHTML += html;
 134 }
 135
 136 function my_onbytarget(data) {
 137     var targetDiv = document.getElementById("bytarget");
 138     var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
 139         +'<td>Records</td><td>State</td></tr></thead><tbody>';
 140
 141     for (var i = 0; i < data.length; i++ ) {
 142         table += "<tr><td>" + data[i].id +
 143             "</td><td>" + data[i].hits +
 144             "</td><td>" + data[i].diagnostic +
 145             "</td><td>" + data[i].records +
 146             "</td><td>" + data[i].state + "</td></tr>";
 147     }
 148
 149     table += '</tbody></table>';
 150     targetDiv.innerHTML = table;
 151 }
 152
 153 ////////////////////////////////////////////////////////////////////////////////
 154 ////////////////////////////////////////////////////////////////////////////////
 155
 156 // wait until the DOM is ready
 157 function domReady ()
 158 {
 159     document.search.onsubmit = onFormSubmitEventHandler;
 160     document.search.query.value = '';
 161     document.select.sort.onchange = onSelectDdChange;
 162     document.select.perpage.onchange = onSelectDdChange;
 163 }
 164
 165 // when search button pressed
 166 function onFormSubmitEventHandler()
 167 {
 168     resetPage();
 169     loadSelect();
 170     triggerSearch();
 171     submitted = true;
 172     return false;
 173 }
 174
 175 function onSelectDdChange()
 176 {
 177     if (!submitted) return false;
 178     resetPage();
 179     loadSelect();
 180     my_paz.show(0, recPerPage, curSort);
 181     return false;
 182 }
 183
 184 function resetPage()
 185 {
 186     curPage = 1;
 187     totalRec = 0;
 188 }
 189
 190 function triggerSearch ()
 191 {
 192     my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
 193 }
 194
 195 function loadSelect ()
 196 {
 197     curSort = document.select.sort.value;
 198     recPerPage = document.select.perpage.value;
 199 }
 200
 201 // limit the query after clicking the facet
 202 function limitQuery (field, value)
 203 {
 204     document.search.query.value += ' and ' + field + '="' + value + '"';
 205     onFormSubmitEventHandler();
 206 }
 207
 208 // limit by target functions
 209 function limitTarget (id, name)
 210 {
 211     var navi = document.getElementById('navi');
 212     navi.innerHTML =
 213         'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
 214         + name + '</a>';
 215     navi.innerHTML += '<hr/>';
 216     curFilter = 'pz:id=' + id;
 217     resetPage();
 218     loadSelect();
 219     triggerSearch();
 220     return false;
 221 }
 222
 223 function delimitTarget ()
 224 {
 225     var navi = document.getElementById('navi');
 226     navi.innerHTML = '';
 227     curFilter = null;
 228     resetPage();
 229     loadSelect();
 230     triggerSearch();
 231     return false;
 232 }
 233
 234 function drawPager (pagerDiv)
 235 {
 236     //client indexes pages from 1 but pz2 from 0
 237     var onsides = 6;
 238     var pages = Math.ceil(totalRec / recPerPage);
 239
 240     var firstClkbl = ( curPage - onsides > 0 )
 241         ? curPage - onsides
 242         : 1;
 243
 244     var lastClkbl = firstClkbl + 2*onsides < pages
 245         ? firstClkbl + 2*onsides
 246         : pages;
 247
 248     var prev = '<span id="prev">&#60;&#60; Prev</span><b> | </b>';
 249     if (curPage > 1)
 250         prev = '<a href="#" id="prev" onclick="pagerPrev();">'
 251         +'&#60;&#60; Prev</a><b> | </b>';
 252
 253     var middle = '';
 254     for(var i = firstClkbl; i <= lastClkbl; i++) {
 255         var numLabel = i;
 256         if(i == curPage)
 257             numLabel = '<b>' + i + '</b>';
 258
 259         middle += '<a href="#" onclick="showPage(' + i + ')"> '
 260             + numLabel + ' </a>';
 261     }
 262
 263     var next = '<b> | </b><span id="next">Next &#62;&#62;</span>';
 264     if (pages - curPage > 0)
 265         next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
 266         +'Next &#62;&#62;</a>';
 267
 268     var predots = '';
 269     if (firstClkbl > 1)
 270         predots = '...';
 271
 272     var postdots = '';
 273     if (lastClkbl < pages)
 274         postdots = '...';
 275
 276     pagerDiv.innerHTML += '<div style="float: clear">'
 277         + prev + predots + middle + postdots + next + '</div><hr/>';
 278 }
 279
 280 function showPage (pageNum)
 281 {
 282     curPage = pageNum;
 283     my_paz.showPage( curPage - 1 );
 284 }
 285
 286 // simple paging functions
 287
 288 function pagerNext() {
 289     if ( totalRec - recPerPage*curPage > 0) {
 290         my_paz.showNext();
 291         curPage++;
 292     }
 293 }
 294
 295 function pagerPrev() {
 296     if ( my_paz.showPrev() != false )
 297         curPage--;
 298 }
 299
 300 // swithing view between targets and records
 301
 302 function switchView(view) {
 303
 304     var targets = document.getElementById('mkwsTargets');
 305     var records = document.getElementById('mkwsRecords');
 306
 307     switch(view) {
 308         case 'targets':
 309             targets.style.display = "block";
 310             records.style.display = "none";
 311             break;
 312         case 'records':
 313             targets.style.display = "none";
 314             records.style.display = "block";
 315             break;
 316         default:
 317             alert('Unknown view.');
 318     }
 319 }
 320
 321 // detailed record drawing
 322 function showDetails (prefixRecId) {
 323     var recId = prefixRecId.replace('rec_', '');
 324     var oldRecId = curDetRecId;
 325     curDetRecId = recId;
 326
 327     // remove current detailed view if any
 328     var detRecordDiv = document.getElementById('det_'+oldRecId);
 329     // lovin DOM!
 330     if (detRecordDiv)
 331       detRecordDiv.parentNode.removeChild(detRecordDiv);
 332
 333     // if the same clicked, just hide
 334     if (recId == oldRecId) {
 335         curDetRecId = '';
 336         curDetRecData = null;
 337         return;
 338     }
 339     // request the record
 340     my_paz.record(recId);
 341 }
 342
 343 function replaceHtml(el, html) {
 344   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
 345   /*@cc_on // Pure innerHTML is slightly faster in IE
 346     oldEl.innerHTML = html;
 347     return oldEl;
 348     @*/
 349   var newEl = oldEl.cloneNode(false);
 350   newEl.innerHTML = html;
 351   oldEl.parentNode.replaceChild(newEl, oldEl);
 352   /* Since we just removed the old element from the DOM, return a reference
 353      to the new element, which can be used to restore variable references. */
 354   return newEl;
 355 };
 356
 357 function renderDetails(data, marker)
 358 {
 359     var details = '<div class="details" id="det_'+data.recid+'"><table>';
 360     if (marker) details += '<tr><td>'+ marker + '</td></tr>';
 361     if (data["md-title"] != undefined) {
 362         details += '<tr><td><b>Title</b></td><td><b>:</b> '+data["md-title"];
 363         if (data["md-title-remainder"] !== undefined) {
 364               details += ' : <span>' + data["md-title-remainder"] + ' </span>';
 365         }
 366         if (data["md-title-responsibility"] !== undefined) {
 367               details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
 368         }
 369           details += '</td></tr>';
 370     }
 371     if (data["md-date"] != undefined)
 372         details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
 373     if (data["md-author"] != undefined)
 374         details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
 375     if (data["md-electronic-url"] != undefined)
 376         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>';
 377     if (data["location"][0]["md-subject"] != undefined)
 378         details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
 379     if (data["location"][0]["@name"] != undefined)
 380         details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
 381     details += '</table></div>';
 382     return details;
 383 }
 384
 385 /*
 386  * All the HTML stuff to render the search forms and
 387  * result pages.
 388  */
 389 function mkws_html_all(data) {
 390
 391     /* default config */
 392     var config = {
 393         sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
 394         perpage: [10, 20, 30, 50],
 395         sort_default: "relevance",
 396         perpage_default: 20,
 397         query_width: 50,
 398         switch: true, /* show/hide Records|Targets menu */
 399
 400         dummy: "dummy"
 401     };
 402
 403     /* override standard config values by function parameters */
 404     for (var k in data) {
 405         config[k] = data[k];
 406     }
 407
 408     // For some reason, doing this programmatically results in
 409     // document.search.query being undefined, hence the raw HTML.
 410     $("#mkwsSearch").html('\
 411     <form id="searchForm" name="search">\
 412       <input id="query" type="text" size="50" />\
 413       <input id="button" type="submit" value="Search" />\
 414     </form>');
 415
 416     $("#mkwsRecords").html('\
 417       <table width="100%" border="0" cellpadding="6" cellspacing="0">\
 418         <tr>\
 419           <td width="250" valign="top">\
 420             <div id="termlist"></div>\
 421           </td>\
 422           <td valign="top">\
 423             <div id="ranking">\
 424               <form name="select" id="select">\
 425         Sort by' + mkws_html_sort(config) + '\
 426         and show ' + mkws_html_perpage(config) + '\
 427         per page.\
 428        </form>\
 429             </div>\
 430             <div id="pager"></div>\
 431             <div id="navi"></div>\
 432             <div id="results"></div>\
 433           </td>\
 434         </tr>\
 435       </table>\
 436     </div>');
 437
 438     mkws_html_switch(config);
 439     if (mkws_config.use_service_proxy)
 440         mkws_service_proxy_auth(config.service_proxy_auth);
 441
 442     domReady();
 443 }
 444
 445 function mkws_html_switch(config) {
 446     $("#mkwsSwitch").html($("<a/>", {
 447         href: '#',
 448         onclick: "switchView(\'records\')",
 449         text: "Records"
 450     }));
 451     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
 452     $("#mkwsSwitch").append($("<a/>", {
 453         href: '#',
 454         onclick: "switchView(\'targets\')",
 455         text: "Targets"
 456     }));
 457
 458     $("#mkwsTargets").html('\
 459       <div id="bytarget">\
 460        No information available yet.\
 461       </div>');
 462     $("#mkwsTargets").css("display", "none");
 463
 464     if (!config.switch) {
 465         $("#mkwsSwitch").css("display", "none");
 466     }
 467 }
 468
 469 function mkws_html_sort(config) {
 470     var sort_html = '<select name="sort" id="sort">';
 471
 472     for(var i = 0; i < config.sort.length; i++) {
 473         var key = config.sort[i][0];
 474         var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
 475
 476         sort_html += '<option value="' + key + '"';
 477         if (key == config.sort_default) {
 478             sort_html += ' selected="selected"';
 479         }
 480         sort_html += '>' + val + '</option>';
 481     }
 482     sort_html += '</select>';
 483
 484     return sort_html;
 485 }
 486
 487 function mkws_html_perpage(config) {
 488     var perpage_html = '<select name="perpage" id="perpage">';
 489
 490     for(var i = 0; i < config.perpage.length; i++) {
 491         var key = config.perpage[i];
 492
 493         perpage_html += '<option value="' + key + '"';
 494         if (key == config.perpage_default) {
 495             perpage_html += ' selected="selected"';
 496         }
 497         perpage_html += '>' + key + '</option>';
 498     }
 499     perpage_html += '</select>';
 500
 501     return perpage_html;
 502 }
 503
 504 /*
 505  * Run service-proxy authentication in background (after page load).
 506  * The username/password is configured in the apache config file
 507  * for the site.
 508  */
 509 function mkws_service_proxy_auth(auth_url) {
 510     if (!auth_url)
 511         auth_url = "/service-proxy-auth";
 512
 513     var jqxhr = jQuery.get(auth_url)
 514         .fail(function() {
 515             alert("service proxy authentication failed, give up!");
 516         })
 517         .success(function(data) {
 518             if (!jQuery.isXMLDoc(data)) {
 519                 alert("service proxy auth response document is not valid XML document, give up!");
 520                 return;
 521             }
 522             var status = $(data).find("status");
 523             if (status.text() != "OK") {
 524                 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
 525                 return;
 526             }
 527         });
 528 }
 529
 530 /* magic */
 531 $(document).ready(function() { mkws_html_all(mkws_config) });