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