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