tools/htdocs/mkws.js

   1 /* A very simple client that shows a basic usage of the pz2.js
   2 */
   3
   4 "use strict"; // HTML5: disable for debug_level >= 2
   5
   6 // Set up namespace and some state.
   7 var mkws = {
   8     filters: [],
   9 };
  10
  11 /*
  12  * global config object: mkws_config
  13  *
  14  * Needs to be defined in the HTML header before including this JS file.
  15  * Define empty mkws_config for simple applications that don't define it.
  16  */
  17 if (!mkws_config)
  18     var mkws_config = {};
  19
  20 // Wrapper for jQuery
  21 (function ($) {
  22
  23 mkws.locale_lang = {
  24     "de": {
  25         "Authors": "Autoren",
  26         "Subjects": "Schlagw&ouml;rter",
  27         "Sources": "Daten und Quellen",
  28         "Termlists": "Termlisten",
  29         "Next": "Weiter",
  30         "Prev": "Zur&uuml;ck",
  31         "Search": "Suche",
  32         "Sort by": "Sortieren nach",
  33         "and show": "und zeige",
  34         "per page": "pro Seite",
  35         "Displaying": "Zeige",
  36         "to": "von",
  37         "of": "aus",
  38         "found": "gefunden",
  39         "Title": "Titel",
  40         "Author": "Autor",
  41         "Date": "Datum",
  42         "Subject": "Schlagwort",
  43         "Location": "Ort",
  44         // ### to add: Records, Targets
  45
  46         "dummy": "dummy"
  47     },
  48
  49     "da": {
  50         "Authors": "Forfattere",
  51         "Subjects": "Emner",
  52         "Sources": "Kilder",
  53         "Termlists": "Termlists",
  54         "Next": "N&aelig;ste",
  55         "Prev": "Forrige",
  56         "Search": "S&oslash;g",
  57         "Sort by": "Sorter efter",
  58         "and show": "og vis",
  59         "per page": "per side",
  60         "Displaying": "Viser",
  61         "to": "til",
  62         "of": "ud af",
  63         "found": "fandt",
  64         "Title": "Title",
  65         "Author": "Forfatter",
  66         "Date": "Dato",
  67         "Subject": "Emneord",
  68         "Location": "Lokation",
  69         // ### to add: Records, Targets
  70
  71         "dummy": "dummy"
  72     }
  73 };
  74
  75 // keep time state for debugging
  76 mkws.debug_time = {
  77     "start": $.now(),
  78     "last": $.now()
  79 };
  80
  81 mkws.debug_function = function (string) {
  82     if (!mkws.debug_level)
  83         return;
  84
  85     if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
  86         return;
  87     }
  88
  89     var now = $.now();
  90     var timestamp = (now - mkws.debug_time.start)/1000 + " (+" + (now - mkws.debug_time.last)/1000 + ") "
  91     mkws.debug_time.last = now;
  92
  93     // you need to disable use strict at the top of the file!!!
  94     if (mkws.debug_level >= 3) {
  95         console.log(timestamp + arguments.callee.caller);
  96     } else if (mkws.debug_level >= 2) {
  97         console.log(timestamp + ">>> called from function " + arguments.callee.caller.name + ' <<<');
  98     }
  99     console.log(timestamp + string);
 100 }
 101 var debug = mkws.debug_function; // local alias
 102
 103 {
 104     /* default mkws config */
 105     var config_default = {
 106         use_service_proxy: true,
 107         service_proxy_auth: "http://mkws.indexdata.com/service-proxy-auth",
 108         lang: "",
 109         sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
 110         perpage_options: [10, 20, 30, 50],
 111         sort_default: "relevance",
 112         perpage_default: 20,
 113         query_width: 50,
 114         show_lang: true,        /* show/hide language menu */
 115         show_sort: true,        /* show/hide sort menu */
 116         show_perpage: true,     /* show/hide perpage menu */
 117         lang_options: [],       /* display languages links for given languages, [] for all */
 118         facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
 119         responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
 120         debug_level: 1,     /* debug level for development: 0..2 */
 121
 122         dummy: "dummy"
 123     };
 124
 125     /* set global debug_level flag early */
 126     if (typeof mkws_config.debug_level !== 'undefined') {
 127         mkws.debug_level = mkws_config.debug_level;
 128     } else if (typeof config_default.debug_level !== 'undefined') {
 129         mkws.debug_level = config_default.debug_level;
 130     }
 131
 132     /* override standard config values by function parameters */
 133     for (var k in config_default) {
 134         if (typeof mkws_config[k] === 'undefined')
 135            mkws_config[k] = config_default[k];
 136         debug("Set config: " + k + ' => ' + mkws_config[k]);
 137     }
 138 }
 139
 140 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
 141     debug("Reset query width: " + mkws_config.query_width);
 142     mkws_config.query_width = 50;
 143 }
 144
 145 for (var key in mkws_config) {
 146     if (mkws_config.hasOwnProperty(key)) {
 147         if (key.match(/^language_/)) {
 148             var lang = key.replace(/^language_/, "");
 149             // Copy custom languages into list
 150             mkws.locale_lang[lang] = mkws_config[key];
 151             debug("Added locally configured language '" + lang + "'");
 152         }
 153     }
 154 }
 155
 156
 157 // create a parameters array and pass it to the pz2's constructor
 158 // then register the form submit event with the pz2.search function
 159 // autoInit is set to true on default
 160 var my_paz = new pz2( { "onshow": my_onshow,
 161                     "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
 162                     "pazpar2path": mkws_config.pazpar2_url || "http://mkws.indexdata.com/service-proxy/",
 163                     "oninit": my_oninit,
 164                     "onstat": my_onstat,
 165                     "onterm": my_onterm,
 166                     "termlist": "xtargets,subject,author",
 167                     "onbytarget": my_onbytarget,
 168                     "usesessions" : mkws_config.use_service_proxy ? false : true,
 169                     "showResponseType": '', // or "json" (for debugging?)
 170                     "onrecord": my_onrecord } );
 171
 172 mkws.my_paz = my_paz; // export
 173
 174 // some state vars
 175 var curPage = 1;
 176 var recPerPage = 20;
 177 var totalRec = 0;
 178 var curDetRecId = '';
 179 var curDetRecData = null;
 180 var curSort = 'relevance';
 181 var submitted = false;
 182 var SourceMax = 16;
 183 var SubjectMax = 10;
 184 var AuthorMax = 10;
 185
 186 //
 187 // pz2.js event handlers:
 188 //
 189 function my_oninit() {
 190     my_paz.stat();
 191     my_paz.bytarget();
 192 }
 193
 194 function my_onshow(data) {
 195     totalRec = data.merged;
 196     // move it out
 197     var pager = document.getElementById("mkwsPager");
 198     if (pager) {
 199         pager.innerHTML = "";
 200         pager.innerHTML +='<div style="float: right">' + M('Displaying') + ': '
 201             + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
 202             ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
 203             + data.total + ')</div>';
 204         drawPager(pager);
 205     }
 206
 207     // navi
 208     var results = document.getElementById("mkwsRecords");
 209
 210     var html = [];
 211     for (var i = 0; i < data.hits.length; i++) {
 212         var hit = data.hits[i];
 213               html.push('<div class="record" id="mkwsRecdiv_'+hit.recid+'" >'
 214             +'<a href="#" id="mkwsRec_'+hit.recid
 215             +'" onclick="mkws.showDetails(this.id);return false;"><b>'
 216             + hit["md-title"] +' </b></a>');
 217               if (hit["md-title-remainder"] !== undefined) {
 218                 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
 219               }
 220               if (hit["md-title-responsibility"] !== undefined) {
 221             html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
 222         }
 223         if (hit.recid == curDetRecId) {
 224             html.push(renderDetails(curDetRecData));
 225         }
 226         html.push('</div>');
 227     }
 228     replaceHtml(results, html.join(''));
 229 }
 230
 231 function my_onstat(data) {
 232     var stat = document.getElementById("mkwsStat");
 233     if (stat == null)
 234         return;
 235
 236     stat.innerHTML = '<span class="head">' + M('Status info') + '</span>' +
 237         ' -- ' +
 238         '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
 239         ' -- ' +
 240         '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>';
 241 }
 242
 243 function my_onterm(data) {
 244     // no facets
 245     if (!mkws_config.facets || mkws_config.facets.length == 0) {
 246         $("#mkwsTermlists").hide();
 247         return;
 248     }
 249
 250     // display if we first got results
 251     $("#mkwsTermlists").show();
 252
 253     var acc = [];
 254     acc.push('<div class="title">' + M('Termlists') + '</div>');
 255     var facets = mkws_config.facets;
 256
 257     for(var i = 0; i < facets.length; i++) {
 258         if (facets[i] == "sources") {
 259             add_single_facet(acc, "Sources",  data.xtargets, SourceMax, null);
 260         } else if (facets[i] == "subjects") {
 261             add_single_facet(acc, "Subjects", data.subject,  SubjectMax, "subject");
 262         } else if (facets[i] == "authors") {
 263             add_single_facet(acc, "Authors",  data.author,   AuthorMax, "author");
 264         } else {
 265             alert("bad facet configuration: '" + facets[i] + "'");
 266         }
 267     }
 268
 269     var termlist = document.getElementById("mkwsTermlists");
 270     replaceHtml(termlist, acc.join(''));
 271 }
 272
 273 function add_single_facet(acc, caption, data, max, pzIndex) {
 274     acc.push('<div class="facet" id="mkwsFacet' + caption + '">');
 275     acc.push('<div class="termtitle">' + M(caption) + '</div>');
 276     for (var i = 0; i < data.length && i < max; i++ ) {
 277         acc.push('<div class="term">');
 278         acc.push('<a href="#" ');
 279         var action;
 280         if (!pzIndex) {
 281             // Special case: target selection
 282             acc.push('target_id='+data[i].id+' ');
 283             action = 'mkws.limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
 284         } else {
 285             action = 'mkws.limitQuery(\'' + pzIndex + '\', this.firstChild.nodeValue)';
 286         }
 287         acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
 288                  + ' <span>' + data[i].freq + '</span>');
 289         acc.push('</div>');
 290     }
 291     acc.push('</div>');
 292 }
 293
 294 function my_onrecord(data) {
 295     // FIXME: record is async!!
 296     clearTimeout(my_paz.recordTimer);
 297     // in case on_show was faster to redraw element
 298     var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
 299     if (detRecordDiv) return;
 300     curDetRecData = data;
 301     var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
 302     var html = renderDetails(curDetRecData);
 303     recordDiv.innerHTML += html;
 304 }
 305
 306 function my_onbytarget(data) {
 307     var targetDiv = document.getElementById("mkwsBytarget");
 308     if (!targetDiv) {
 309         // No mkwsTargets div.
 310         return;
 311     }
 312
 313     var table ='<table><thead><tr>' +
 314         '<td>' + M('Target ID') + '</td>' +
 315         '<td>' + M('Hits') + '</td>' +
 316         '<td>' + M('Diags') + '</td>' +
 317         '<td>' + M('Records') + '</td>' +
 318         '<td>' + M('State') + '</td>' +
 319         '</tr></thead><tbody>';
 320
 321     for (var i = 0; i < data.length; i++ ) {
 322         table += "<tr><td>" + data[i].id +
 323             "</td><td>" + data[i].hits +
 324             "</td><td>" + data[i].diagnostic +
 325             "</td><td>" + data[i].records +
 326             "</td><td>" + data[i].state + "</td></tr>";
 327     }
 328
 329     table += '</tbody></table>';
 330     targetDiv.innerHTML = table;
 331 }
 332
 333 ////////////////////////////////////////////////////////////////////////////////
 334 ////////////////////////////////////////////////////////////////////////////////
 335
 336 // wait until the DOM is ready
 337 function domReady ()
 338 {
 339     document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler;
 340     document.mkwsSearchForm.mkwsQuery.value = '';
 341     if (document.mkwsSelect) {
 342         if (document.mkwsSelect.mkwsSort)
 343             document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
 344         if (document.mkwsSelect.mkwsPerpage)
 345             document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
 346     }
 347 }
 348
 349 // when search button pressed
 350 function onFormSubmitEventHandler()
 351 {
 352     resetPage();
 353     loadSelect();
 354     triggerSearch();
 355     mkws.switchView('records'); // In case it's configured to start off as hidden
 356     submitted = true;
 357     return false;
 358 }
 359
 360 function onSelectDdChange()
 361 {
 362     if (!submitted) return false;
 363     resetPage();
 364     loadSelect();
 365     my_paz.show(0, recPerPage, curSort);
 366     return false;
 367 }
 368
 369 function resetPage()
 370 {
 371     curPage = 1;
 372     totalRec = 0;
 373 }
 374
 375 function triggerSearch ()
 376 {
 377     var pp2filter = "";
 378     var pp2limit = "";
 379
 380     for (var i in mkws.filters) {
 381         var filter = mkws.filters[i];
 382         if (filter.id) {
 383             if (pp2filter)
 384                 pp2filter += ",";
 385             pp2filter += 'pz:id=' + filter.id;
 386         } else {
 387             if (pp2limit)
 388                 pp2limit += ",";
 389             pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
 390         }
 391     }
 392
 393     debug("triggerSearch: filters = " + JSON.stringify(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit);
 394     my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, pp2filter, undefined, { limit: pp2limit });
 395 }
 396
 397 function loadSelect ()
 398 {
 399     if (document.mkwsSelect) {
 400         if (document.mkwsSelect.mkwsSort)
 401             curSort = document.mkwsSelect.mkwsSort.value;
 402         if (document.mkwsSelect.mkwsPerpage)
 403             recPerPage = document.mkwsSelect.mkwsPerpage.value;
 404     }
 405 }
 406
 407 // limit the query after clicking the facet
 408 mkws.limitQuery = function (field, value)
 409 {
 410     debug("limitQuery(field=" + field + ", value=" + value + ")");
 411     mkws.filters.push({ field: field, value: value });
 412     redraw_navi();
 413     resetPage();
 414     loadSelect();
 415     triggerSearch();
 416     return false;
 417 }
 418
 419 // limit by target functions
 420 mkws.limitTarget  = function (id, name)
 421 {
 422     debug("limitTarget(id=" + id + ", name=" + name + ")");
 423     mkws.filters.push({ id: id, name: name });
 424     redraw_navi();
 425     resetPage();
 426     loadSelect();
 427     triggerSearch();
 428     return false;
 429 }
 430
 431 mkws.delimitQuery = function (field, value)
 432 {
 433     debug("delimitQuery(field=" + field + ", value=" + value + ")");
 434     var newFilters = [];
 435     for (var i in mkws.filters) {
 436         var filter = mkws.filters[i];
 437         if (filter.field &&
 438             field == filter.field &&
 439             value == filter.value) {
 440             debug("delimitTarget() removing filter " + JSON.stringify(filter));
 441         } else {
 442             debug("delimitTarget() keeping filter " + JSON.stringify(filter));
 443             newFilters.push(filter);
 444         }
 445     }
 446     mkws.filters = newFilters;
 447
 448     redraw_navi();
 449     resetPage();
 450     loadSelect();
 451     triggerSearch();
 452     return false;
 453 }
 454
 455
 456 mkws.delimitTarget = function (id)
 457 {
 458     debug("delimitTarget(id=" + id + ")");
 459     var newFilters = [];
 460     for (var i in mkws.filters) {
 461         var filter = mkws.filters[i];
 462         if (filter.id) {
 463             debug("delimitTarget() removing filter " + JSON.stringify(filter));
 464         } else {
 465             debug("delimitTarget() keeping filter " + JSON.stringify(filter));
 466             newFilters.push(filter);
 467         }
 468     }
 469     mkws.filters = newFilters;
 470
 471     redraw_navi();
 472     resetPage();
 473     loadSelect();
 474     triggerSearch();
 475     return false;
 476 }
 477
 478
 479 function redraw_navi ()
 480 {
 481     var navi = document.getElementById('mkwsNavi');
 482     if (!navi) return;
 483
 484     var text = "";
 485     for (var i in mkws.filters) {
 486         if (text) {
 487             text += " | ";
 488         }
 489         var filter = mkws.filters[i];
 490         if (filter.id) {
 491             text += 'Source: <a class="crossout" href="#" onclick="mkws.delimitTarget(' +
 492                 "'" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
 493         } else {
 494             text += filter.field + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(' +
 495                 "'" + filter.field + "', '" + filter.value + "'" +
 496                 ');return false;">' + filter.value + '</a>';
 497         }
 498     }
 499
 500     navi.innerHTML = text;
 501 }
 502
 503
 504 function drawPager (pagerDiv)
 505 {
 506     //client indexes pages from 1 but pz2 from 0
 507     var onsides = 6;
 508     var pages = Math.ceil(totalRec / recPerPage);
 509
 510     var firstClkbl = ( curPage - onsides > 0 )
 511         ? curPage - onsides
 512         : 1;
 513
 514     var lastClkbl = firstClkbl + 2*onsides < pages
 515         ? firstClkbl + 2*onsides
 516         : pages;
 517
 518     var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
 519     if (curPage > 1)
 520         prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
 521         +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
 522
 523     var middle = '';
 524     for(var i = firstClkbl; i <= lastClkbl; i++) {
 525         var numLabel = i;
 526         if(i == curPage)
 527             numLabel = '<b>' + i + '</b>';
 528
 529         middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
 530             + numLabel + ' </a>';
 531     }
 532
 533     var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
 534     if (pages - curPage > 0)
 535         next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
 536         + M('Next') + ' &#62;&#62;</a>';
 537
 538     var predots = '';
 539     if (firstClkbl > 1)
 540         predots = '...';
 541
 542     var postdots = '';
 543     if (lastClkbl < pages)
 544         postdots = '...';
 545
 546     pagerDiv.innerHTML += '<div style="float: clear">'
 547         + prev + predots + middle + postdots + next + '</div>';
 548 }
 549
 550 mkws.showPage = function (pageNum)
 551 {
 552     curPage = pageNum;
 553     my_paz.showPage( curPage - 1 );
 554 }
 555
 556 // simple paging functions
 557
 558 mkws.pagerNext = function () {
 559     if ( totalRec - recPerPage*curPage > 0) {
 560         my_paz.showNext();
 561         curPage++;
 562     }
 563 }
 564
 565 mkws.pagerPrev = function () {
 566     if ( my_paz.showPrev() != false )
 567         curPage--;
 568 }
 569
 570 // switching view between targets and records
 571
 572 mkws.switchView = function(view) {
 573     debug("switchView: " + view);
 574
 575     var targets = document.getElementById('mkwsTargets');
 576     var results = document.getElementById('mkwsResults') ||
 577                   document.getElementById('mkwsRecords');
 578     var blanket = document.getElementById('mkwsBlanket');
 579     var motd    = document.getElementById('mkwsMOTD');
 580
 581     switch(view) {
 582         case 'targets':
 583             if (targets) targets.style.display = "block";
 584             if (results) results.style.display = "none";
 585             if (blanket) blanket.style.display = "none";
 586             if (motd) motd.style.display = "none";
 587             break;
 588         case 'records':
 589             if (targets) targets.style.display = "none";
 590             if (results) results.style.display = "block";
 591             if (blanket) blanket.style.display = "block";
 592             if (motd) motd.style.display = "none";
 593             break;
 594         case 'none':
 595             if (targets) targets.style.display = "none";
 596             if (results) results.style.display = "none";
 597             if (blanket) blanket.style.display = "none";
 598             if (motd) motd.style.display = "none";
 599             break;
 600         default:
 601             alert("Unknown view '" + view + "'");
 602     }
 603 }
 604
 605 // detailed record drawing
 606 mkws.showDetails = function (prefixRecId) {
 607     var recId = prefixRecId.replace('mkwsRec_', '');
 608     var oldRecId = curDetRecId;
 609     curDetRecId = recId;
 610
 611     // remove current detailed view if any
 612     var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
 613     // lovin DOM!
 614     if (detRecordDiv)
 615       detRecordDiv.parentNode.removeChild(detRecordDiv);
 616
 617     // if the same clicked, just hide
 618     if (recId == oldRecId) {
 619         curDetRecId = '';
 620         curDetRecData = null;
 621         return;
 622     }
 623     // request the record
 624     my_paz.record(recId);
 625 }
 626
 627 function replaceHtml(el, html) {
 628   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
 629   /*@cc_on // Pure innerHTML is slightly faster in IE
 630     oldEl.innerHTML = html;
 631     return oldEl;
 632     @*/
 633   var newEl = oldEl.cloneNode(false);
 634   newEl.innerHTML = html;
 635   oldEl.parentNode.replaceChild(newEl, oldEl);
 636   /* Since we just removed the old element from the DOM, return a reference
 637      to the new element, which can be used to restore variable references. */
 638   return newEl;
 639 };
 640
 641 function renderDetails(data, marker)
 642 {
 643     if (mkws.templateRecord === undefined) {
 644         maybeLoadTemplate("Record");
 645     }
 646
 647     if (mkws.templateRecord) {
 648         var template = mkws.templateRecord;
 649         return template(data);
 650     }
 651
 652     var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
 653     if (marker) details += '<tr><td colspan="2">'+ marker + '</td></tr>';
 654
 655     var locations = [];
 656     for (var i in data.location) {
 657         locations.push(data.location[i]['@name']);
 658     }
 659
 660     details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
 661     details += renderField("Date", data["md-date"]);
 662     details += renderField("Author", data["md-author"]);
 663     details += renderField("URL", data["md-electronic-url"]);
 664     details += renderField("Subject", data["location"][0]["md-subject"]);
 665     if (locations.length == 0) {
 666         details += '<tr><td colspan="2">No locations for record!</td></tr>';
 667     } else {
 668         details += renderField("Location" + (locations.length == 1 ? "" : "s"), locations);
 669     }
 670     details += '</table></div>';
 671
 672     return details;
 673 }
 674
 675
 676 function maybeLoadTemplate(name)
 677 {
 678     var source = $("#mkwsTemplate" + name).html();
 679     if (!source) {
 680         debug("no template '" + name + "': falling back to default behaviour");
 681         // Mark template as not provided
 682         mkws['template' + name] = 0;
 683         return;
 684     }
 685
 686     var template = Handlebars.compile(source);
 687     debug("compiled template '" + name + "'");
 688     mkws['template' + name] = template;
 689 }
 690
 691
 692 function renderField(caption, data, data2, data3) {
 693     if (data === undefined) {
 694         return "";
 695     }
 696
 697     var res = "";
 698     for (var i = 0; i < data.length; i++) {
 699         var s = data[i];
 700         if (i > 0)
 701             res += ", ";
 702
 703         if (caption == "URL")
 704             s = '<a href="' + s + '" target="_blank">' + s + '</a>';
 705
 706         res += s
 707     }
 708
 709     if (data2 != undefined) {
 710         res = res + " (" + data2 + ")";
 711     }
 712
 713     if (data3 != undefined) {
 714         res = res + " <i>" + data3 + "</i>";
 715     }
 716
 717     return '<tr><th>' + M(caption) + '</th><td>' + res + '</td></tr>';
 718 }
 719
 720
 721 /*
 722  * All the HTML stuff to render the search forms and
 723  * result pages.
 724  */
 725 function mkws_html_all() {
 726     mkws_set_lang();
 727     if (mkws_config.show_lang)
 728         mkws_html_lang();
 729
 730     // For some reason, doing this programmatically results in
 731     // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
 732     debug("HTML search form");
 733     $("#mkwsSearch").html('\
 734     <form name="mkwsSearchForm" action="" >\
 735       <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
 736       <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
 737     </form>');
 738
 739     debug("HTML records");
 740     // If the application has an #mkwsResults, populate it in the
 741     // usual way. If not, assume that it's a smarter application that
 742     // defines its own subcomponents:
 743     //  #mkwsTermlists
 744     //  #mkwsRanking
 745     //  #mkwsPager
 746     //  #mkwsNavi
 747     //  #mkwsRecords
 748     if ($("#mkwsResults").length) {
 749         $("#mkwsResults").html('\
 750       <table width="100%" border="0" cellpadding="6" cellspacing="0">\
 751         <tr>\
 752           <td id="mkwsTermlistContainer1" width="250" valign="top">\
 753             <div id="mkwsTermlists"></div>\
 754           </td>\
 755           <td id="mkwsMOTDContainer" valign="top">\
 756             <div id="mkwsRanking"></div>\
 757             <div id="mkwsPager"></div>\
 758             <div id="mkwsNavi"></div>\
 759             <div id="mkwsRecords"></div>\
 760           </td>\
 761         </tr>\
 762         <tr>\
 763           <td colspan="2">\
 764             <div id="mkwsTermlistContainer2"></div>\
 765           </td>\
 766         </tr>\
 767       </table>');
 768     }
 769
 770     if ($("#mkwsRanking").length) {
 771         var ranking_data = '';
 772         ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
 773         if (mkws_config.show_sort) {
 774             ranking_data +=  M('Sort by') + ' ' + mkws_html_sort() + ' ';
 775         }
 776         if (mkws_config.show_perpage) {
 777             ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
 778         }
 779         ranking_data += '</form>';
 780
 781         $("#mkwsRanking").html(ranking_data);
 782     }
 783
 784     mkws_html_switch();
 785
 786     if (mkws_config.use_service_proxy)
 787           mkws_service_proxy_auth(mkws_config.service_proxy_auth,
 788           mkws_config.service_proxy_auth_domain);
 789
 790     if (mkws_config.responsive_design_width) {
 791         // Responsive web design - change layout on the fly based on
 792         // current screen width. Required for mobile devices.
 793         $(window).resize( function(e) { mkws_resize_page() });
 794         // initial check after page load
 795         $(document).ready(function() { mkws_resize_page() });
 796     }
 797
 798     domReady();
 799
 800     // on first page, hide the termlist
 801     $(document).ready(function() { $("#mkwsTermlists").hide(); } );
 802     var motd = document.getElementById("mkwsMOTD");
 803     var container = document.getElementById("mkwsMOTDContainer");
 804     if (motd && container) {
 805         // Move the MOTD from the provided element down into the container
 806         motd.parentNode.removeChild(motd);
 807         container.appendChild(motd);
 808     }
 809 }
 810
 811 function mkws_set_lang()  {
 812     var lang = $.parseQuerystring().lang || mkws_config.lang;
 813     if (!lang || !mkws.locale_lang[lang]) {
 814         mkws_config.lang = ""
 815     } else {
 816         mkws_config.lang = lang;
 817     }
 818
 819     debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
 820     return mkws_config.lang;
 821 }
 822
 823 function mkws_html_switch() {
 824     debug("HTML switch");
 825
 826     $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_records" onclick="mkws.switchView(\'records\')">' + M('Records') + '</a>'));
 827     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
 828     $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_targets" onclick="mkws.switchView(\'targets\')">' + M('Targets') + '</a>'));
 829
 830     debug("HTML targets");
 831     $("#mkwsTargets").html('\
 832       <div id="mkwsBytarget">\
 833        No information available yet.\
 834       </div>');
 835     $("#mkwsTargets").css("display", "none");
 836 }
 837
 838 function mkws_html_sort() {
 839     debug("HTML sort");
 840     var sort_html = '<select name="mkwsSort" id="mkwsSort">';
 841
 842     for(var i = 0; i < mkws_config.sort_options.length; i++) {
 843         var opt = mkws_config.sort_options[i];
 844         var key = opt[0];
 845         var val = opt.length == 1 ? opt[0] : opt[1];
 846
 847         sort_html += '<option value="' + key + '"';
 848         if (key == mkws_config.sort_default) {
 849             sort_html += ' selected="selected"';
 850         }
 851         sort_html += '>' + M(val) + '</option>';
 852     }
 853     sort_html += '</select>';
 854
 855     return sort_html;
 856 }
 857
 858 function mkws_html_perpage() {
 859     debug("HTML perpage");
 860     var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
 861
 862     for(var i = 0; i < mkws_config.perpage_options.length; i++) {
 863         var key = mkws_config.perpage_options[i];
 864
 865         perpage_html += '<option value="' + key + '"';
 866         if (key == mkws_config.perpage_default) {
 867             perpage_html += ' selected="selected"';
 868         }
 869         perpage_html += '>' + key + '</option>';
 870     }
 871     perpage_html += '</select>';
 872
 873     return perpage_html;
 874 }
 875
 876 /*
 877  * Run service-proxy authentication in background (after page load).
 878  * The username/password is configured in the apache config file
 879  * for the site.
 880  */
 881 function mkws_service_proxy_auth(auth_url, auth_domain) {
 882     debug("Run service proxy auth URL: " + auth_url);
 883
 884     var request = new pzHttpRequest(auth_url, function(err) {
 885           alert("HTTP call for authentication failed: " + err)
 886           return;
 887     }, auth_domain);
 888
 889     request.get(null, function(data) {
 890         if (!$.isXMLDoc(data)) {
 891             alert("service proxy auth response document is not valid XML document, give up!");
 892             return;
 893         }
 894         var status = $(data).find("status");
 895         if (status.text() != "OK") {
 896             alert("service proxy auth repsonse status: " + status.text() + ", give up!");
 897             return;
 898         }
 899
 900         debug("Service proxy auth successfully done");
 901         mkws.service_proxy_auth = true;
 902     });
 903 }
 904
 905 /* create locale language menu */
 906 function mkws_html_lang() {
 907     var lang_default = "en";
 908     var lang = mkws_config.lang || lang_default;
 909     var list = [];
 910
 911     /* display a list of configured languages, or all */
 912     var lang_options = mkws_config.lang_options || [];
 913     var hash = {};
 914     for (var i = 0; i < lang_options.length; i++) {
 915         hash[lang_options[i]] = 1;
 916     }
 917
 918     for (var k in mkws.locale_lang) {
 919         if (hash[k] == 1 || lang_options.length == 0)
 920             list.push(k);
 921     }
 922
 923     // add english link
 924     if (lang_options.length == 0 || hash[lang_default] == 1)
 925         list.push(lang_default);
 926
 927     debug("Language menu for: " + list.join(", "));
 928
 929     /* the HTML part */
 930     var data = "";
 931     for(var i = 0; i < list.length; i++) {
 932         var l = list[i];
 933
 934         if (data)
 935             data += ' | ';
 936
 937         if (lang == l) {
 938             data += ' <span>' + l + '</span> ';
 939         } else {
 940             data += ' <a href="?lang=' + l + '">' + l + '</a> '
 941         }
 942     }
 943
 944     $("#mkwsLang").html(data);
 945 }
 946
 947 function mkws_resize_page () {
 948     var list = ["mkwsSwitch"];
 949
 950     var width = mkws_config.responsive_design_width;
 951     var parentId = $("#mkwsTermlists").parent().attr('id');
 952
 953     if ($(window).width() <= width &&
 954         parentId === "mkwsTermlistContainer1") {
 955         debug("changing from wide to narrow: " + $(window).width());
 956         $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer2"));
 957         $("#mkwsTermlistContainer1").hide();
 958         $("#mkwsTermlistContainer2").show();
 959         for(var i = 0; i < list.length; i++) {
 960             $("#" + list[i]).hide();
 961         }
 962     } else if ($(window).width() > width &&
 963         parentId === "mkwsTermlistContainer2") {
 964         debug("changing from narrow to wide: " + $(window).width());
 965         $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer1"));
 966         $("#mkwsTermlistContainer1").show();
 967         $("#mkwsTermlistContainer2").hide();
 968         for(var i = 0; i < list.length; i++) {
 969             $("#" + list[i]).show();
 970         }
 971     }
 972 };
 973
 974 /* locale */
 975 function M(word) {
 976     var lang = mkws_config.lang;
 977
 978     if (!lang || !mkws.locale_lang[lang])
 979         return word;
 980
 981     return mkws.locale_lang[lang][word] || word;
 982 }
 983
 984 /*
 985  * implement jQuery plugins
 986  */
 987 $.extend({
 988     // implement $.parseQuerystring() for parsing URL parameters
 989     parseQuerystring: function() {
 990         var nvpair = {};
 991         var qs = window.location.search.replace('?', '');
 992         var pairs = qs.split('&');
 993         $.each(pairs, function(i, v){
 994             var pair = v.split('=');
 995             nvpair[pair[0]] = pair[1];
 996         });
 997         return nvpair;
 998     },
 999
1000     debug2: function(string) { // delayed debug, internal variables are set after dom ready
1001         setTimeout(function() { debug(string); }, 500);
1002     },
1003
1004     // service-proxy or pazpar2
1005     pazpar2: function(config) {
1006         var id_popup = config.id_popup || "#mkwsPopup";
1007         id_popup = id_popup.replace(/^#/, "");
1008
1009         // simple layout
1010         var div = '<div id="mkwsSwitch"></div>\
1011         <div id="mkwsLang"></div>\
1012         <div id="mkwsSearch"></div>\
1013         <div id="mkwsResults"></div>\
1014         <div id="mkwsTargets"></div>\
1015         <div id="mkwsStat"></div>';
1016
1017         // new table layout
1018         var table = '\
1019         <style type="text/css">\
1020           #mkwsTermlists div.facet {\
1021           float:left;\
1022           width: 30%;\
1023           margin: 0.3em;\
1024           }\
1025           #mkwsStat {\
1026           text-align: right;\
1027           }\
1028         </style>\
1029             \
1030         <table width="100%" border="0">\
1031           <tr>\
1032             <td>\
1033               <div id="mkwsSwitch"></div>\
1034               <div id="mkwsLang"></div>\
1035               <div id="mkwsSearch"></div>\
1036             </td>\
1037           </tr>\
1038           <tr>\
1039             <td>\
1040               <div style="height:500px; overflow: auto">\
1041                 <div id="mkwsPager"></div>\
1042                 <div id="mkwsNavi"></div>\
1043                 <div id="mkwsRecords"></div>\
1044                 <div id="mkwsTargets"></div>\
1045                 <div id="mkwsRanking"></div>\
1046               </div>\
1047             </td>\
1048           </tr>\
1049           <tr>\
1050             <td>\
1051               <div style="height:300px; overflow: hidden">\
1052                 <div id="mkwsTermlists"></div>\
1053               </div>\
1054             </td>\
1055           </tr>\
1056           <tr>\
1057             <td>\
1058               <div id="mkwsStat"></div>\
1059             </td>\
1060           </tr>\
1061         </table>';
1062
1063         var popup = '\
1064           <div id="mkwsSearch"></div>\
1065           <div id="' + id_popup + '">\
1066             <div id="mkwsSwitch"></div>\
1067             <div id="mkwsLang"></div>\
1068             <div id="mkwsResults"></div>\
1069             <div id="mkwsTargets"></div>\
1070             <div id="mkwsStat"></div>\
1071           </div>'
1072
1073         if (config && config.layout == 'div') {
1074             this.debug2("jquery plugin layout: div");
1075             document.write(div);
1076         } else if (config && config.layout == 'popup') {
1077             this.debug2("jquery plugin layout: popup with id: " + id_popup);
1078             document.write(popup);
1079             $(document).ready( function() { init_popup(config); } );
1080         } else {
1081             this.debug2("jquery plugin layout: table");
1082             document.write(table);
1083         }
1084     }
1085 });
1086
1087 function init_popup(obj) {
1088     var config = obj ? obj : {};
1089
1090     var height = config.height || 760;
1091     var width = config.width || 880;
1092     var id_button = config.id_button || "input#mkwsButton";
1093     var id_popup = config.id_popup || "#mkwsPopup";
1094
1095     debug("popup height: " + height + ", width: " + width);
1096
1097     // make sure that jquery-ui was loaded afte jQuery core lib, e.g.:
1098     // <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
1099     if (!$.ui) {
1100         debug("Error: jquery-ui.js is missing, did you included it after jquery core in the HTML file?");
1101         return;
1102     }
1103
1104     $(id_popup).dialog({
1105       closeOnEscape: true,
1106       autoOpen: false,
1107       height: height,
1108       width: width,
1109       modal: true,
1110       resizable: true,
1111       buttons: {
1112               Cancel: function() {
1113                       $(this).dialog("close");
1114               }
1115       },
1116       close: function() { }
1117     });
1118
1119     $(id_button)
1120       .button()
1121       .click(function() {
1122               $(id_popup).dialog("open");
1123       });
1124 };
1125
1126
1127
1128
1129 /* magic */
1130 $(document).ready(function() {
1131     try {
1132         mkws_html_all()
1133     }
1134
1135     catch (e) {
1136         mkws_config.error = e.message;
1137         // alert(e.message);
1138     }
1139 });
1140
1141 })(jQuery);