experiments/spclient/mkws.js

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