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, sort, targets)
 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, sort, targets);
 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, sort, targets)
 452 {
 453     var pp2filter = "";
 454     var pp2limit = "";
 455
 456     // Re-use previous query/sort if new ones are not specified
 457     if (query) {
 458         mkws.query = query;
 459     }
 460     if (sort) {
 461         mkws.sort = sort;
 462     }
 463     if (targets) {
 464         // ### should support multiple |-separated targets
 465         mkws.filters.push({ id: targets, name: targets });
 466     }
 467
 468     for (var i in mkws.filters) {
 469         var filter = mkws.filters[i];
 470         if (filter.id) {
 471             if (pp2filter)
 472                 pp2filter += ",";
 473             pp2filter += 'pz:id=' + filter.id;
 474         } else {
 475             if (pp2limit)
 476                 pp2limit += ",";
 477             pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
 478         }
 479     }
 480
 481     debug("triggerSearch(" + mkws.query + "): filters = " + JSON.stringify(mkws.filters) + ", pp2filter = " + pp2filter + ", pp2limit = " + pp2limit);
 482     my_paz.search(mkws.query, recPerPage, mkws.sort, pp2filter, undefined, { limit: pp2limit });
 483 }
 484
 485 function loadSelect ()
 486 {
 487     if (document.mkwsSelect) {
 488         if (document.mkwsSelect.mkwsSort)
 489             mkws.sort = document.mkwsSelect.mkwsSort.value;
 490         if (document.mkwsSelect.mkwsPerpage)
 491             recPerPage = document.mkwsSelect.mkwsPerpage.value;
 492     }
 493 }
 494
 495 // limit the query after clicking the facet
 496 mkws.limitQuery = function (field, value)
 497 {
 498     debug("limitQuery(field=" + field + ", value=" + value + ")");
 499     mkws.filters.push({ field: field, value: value });
 500     redraw_navi();
 501     resetPage();
 502     loadSelect();
 503     triggerSearch();
 504     return false;
 505 }
 506
 507 // limit by target functions
 508 mkws.limitTarget  = function (id, name)
 509 {
 510     debug("limitTarget(id=" + id + ", name=" + name + ")");
 511     mkws.filters.push({ id: id, name: name });
 512     redraw_navi();
 513     resetPage();
 514     loadSelect();
 515     triggerSearch();
 516     return false;
 517 }
 518
 519 mkws.delimitQuery = function (field, value)
 520 {
 521     debug("delimitQuery(field=" + field + ", value=" + value + ")");
 522     var newFilters = [];
 523     for (var i in mkws.filters) {
 524         var filter = mkws.filters[i];
 525         if (filter.field &&
 526             field == filter.field &&
 527             value == filter.value) {
 528             debug("delimitTarget() removing filter " + JSON.stringify(filter));
 529         } else {
 530             debug("delimitTarget() keeping filter " + JSON.stringify(filter));
 531             newFilters.push(filter);
 532         }
 533     }
 534     mkws.filters = newFilters;
 535
 536     redraw_navi();
 537     resetPage();
 538     loadSelect();
 539     triggerSearch();
 540     return false;
 541 }
 542
 543
 544 mkws.delimitTarget = function (id)
 545 {
 546     debug("delimitTarget(id=" + id + ")");
 547     var newFilters = [];
 548     for (var i in mkws.filters) {
 549         var filter = mkws.filters[i];
 550         if (filter.id) {
 551             debug("delimitTarget() removing filter " + JSON.stringify(filter));
 552         } else {
 553             debug("delimitTarget() keeping filter " + JSON.stringify(filter));
 554             newFilters.push(filter);
 555         }
 556     }
 557     mkws.filters = newFilters;
 558
 559     redraw_navi();
 560     resetPage();
 561     loadSelect();
 562     triggerSearch();
 563     return false;
 564 }
 565
 566
 567 function redraw_navi ()
 568 {
 569     var navi = document.getElementById('mkwsNavi');
 570     if (!navi) return;
 571
 572     var text = "";
 573     for (var i in mkws.filters) {
 574         if (text) {
 575             text += " | ";
 576         }
 577         var filter = mkws.filters[i];
 578         if (filter.id) {
 579             text += 'Source: <a class="crossout" href="#" onclick="mkws.delimitTarget(' +
 580                 "'" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
 581         } else {
 582             text += filter.field + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(' +
 583                 "'" + filter.field + "', '" + filter.value + "'" +
 584                 ');return false;">' + filter.value + '</a>';
 585         }
 586     }
 587
 588     navi.innerHTML = text;
 589 }
 590
 591
 592 function drawPager (pagerDiv)
 593 {
 594     //client indexes pages from 1 but pz2 from 0
 595     var onsides = 6;
 596     var pages = Math.ceil(totalRec / recPerPage);
 597
 598     var firstClkbl = ( curPage - onsides > 0 )
 599         ? curPage - onsides
 600         : 1;
 601
 602     var lastClkbl = firstClkbl + 2*onsides < pages
 603         ? firstClkbl + 2*onsides
 604         : pages;
 605
 606     var prev = '<span id="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
 607     if (curPage > 1)
 608         prev = '<a href="#" id="mkwsPrev" onclick="mkws.pagerPrev();">'
 609         +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
 610
 611     var middle = '';
 612     for(var i = firstClkbl; i <= lastClkbl; i++) {
 613         var numLabel = i;
 614         if(i == curPage)
 615             numLabel = '<b>' + i + '</b>';
 616
 617         middle += '<a href="#" onclick="mkws.showPage(' + i + ')"> '
 618             + numLabel + ' </a>';
 619     }
 620
 621     var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
 622     if (pages - curPage > 0)
 623         next = '<b> | </b><a href="#" id="mkwsNext" onclick="mkws.pagerNext()">'
 624         + M('Next') + ' &#62;&#62;</a>';
 625
 626     var predots = '';
 627     if (firstClkbl > 1)
 628         predots = '...';
 629
 630     var postdots = '';
 631     if (lastClkbl < pages)
 632         postdots = '...';
 633
 634     pagerDiv.innerHTML += '<div style="float: clear">'
 635         + prev + predots + middle + postdots + next + '</div>';
 636 }
 637
 638 mkws.showPage = function (pageNum)
 639 {
 640     curPage = pageNum;
 641     my_paz.showPage( curPage - 1 );
 642 }
 643
 644 // simple paging functions
 645
 646 mkws.pagerNext = function () {
 647     if ( totalRec - recPerPage*curPage > 0) {
 648         my_paz.showNext();
 649         curPage++;
 650     }
 651 }
 652
 653 mkws.pagerPrev = function () {
 654     if ( my_paz.showPrev() != false )
 655         curPage--;
 656 }
 657
 658 // switching view between targets and records
 659
 660 mkws.switchView = function(view) {
 661     debug("switchView: " + view);
 662
 663     var targets = document.getElementById('mkwsTargets');
 664     var results = document.getElementById('mkwsResults') ||
 665                   document.getElementById('mkwsRecords');
 666     var blanket = document.getElementById('mkwsBlanket');
 667     var motd    = document.getElementById('mkwsMOTD');
 668
 669     switch(view) {
 670         case 'targets':
 671             if (targets) targets.style.display = "block";
 672             if (results) results.style.display = "none";
 673             if (blanket) blanket.style.display = "none";
 674             if (motd) motd.style.display = "none";
 675             break;
 676         case 'records':
 677             if (targets) targets.style.display = "none";
 678             if (results) results.style.display = "block";
 679             if (blanket) blanket.style.display = "block";
 680             if (motd) motd.style.display = "none";
 681             break;
 682         case 'none':
 683             if (targets) targets.style.display = "none";
 684             if (results) results.style.display = "none";
 685             if (blanket) blanket.style.display = "none";
 686             if (motd) motd.style.display = "none";
 687             break;
 688         default:
 689             alert("Unknown view '" + view + "'");
 690     }
 691 }
 692
 693 // detailed record drawing
 694 mkws.showDetails = function (prefixRecId) {
 695     var recId = prefixRecId.replace('mkwsRec_', '');
 696     var oldRecId = curDetRecId;
 697     curDetRecId = recId;
 698
 699     // remove current detailed view if any
 700     var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
 701     // lovin DOM!
 702     if (detRecordDiv)
 703       detRecordDiv.parentNode.removeChild(detRecordDiv);
 704
 705     // if the same clicked, just hide
 706     if (recId == oldRecId) {
 707         curDetRecId = '';
 708         curDetRecData = null;
 709         return;
 710     }
 711     // request the record
 712     my_paz.record(recId);
 713 }
 714
 715 function replaceHtml(el, html) {
 716   var oldEl = typeof el === "string" ? document.getElementById(el) : el;
 717   /*@cc_on // Pure innerHTML is slightly faster in IE
 718     oldEl.innerHTML = html;
 719     return oldEl;
 720     @*/
 721   var newEl = oldEl.cloneNode(false);
 722   newEl.innerHTML = html;
 723   oldEl.parentNode.replaceChild(newEl, oldEl);
 724   /* Since we just removed the old element from the DOM, return a reference
 725      to the new element, which can be used to restore variable references. */
 726   return newEl;
 727 };
 728
 729 function renderDetails(data, marker)
 730 {
 731     if (mkws.templateRecord === undefined) {
 732         loadTemplate("Record");
 733     }
 734
 735     var template = mkws.templateRecord;
 736     var details = template(data);
 737     return '<div class="details" id="mkwsDet_' + data.recid + '">' + details + '</div>';
 738 }
 739
 740
 741 function loadTemplate(name)
 742 {
 743     var source = $("#mkwsTemplate" + name).html();
 744     if (!source) {
 745         source = defaultTemplate(name);
 746     }
 747
 748     var template = Handlebars.compile(source);
 749     debug("compiled template '" + name + "'");
 750     mkws['template' + name] = template;
 751 }
 752
 753
 754 function defaultTemplate(name)
 755 {
 756     if (name === 'Record') {
 757         return '\
 758       <table>\
 759         <tr>\
 760           <th>Title</th>\
 761           <td>\
 762             {{md-title}}\
 763             {{#if md-title-remainder}}\
 764               ({{md-title-remainder}})\
 765             {{/if}}\
 766             {{#if md-title-responsibility}}\
 767               <i>{{md-title-responsibility}}</i>\
 768             {{/if}}\
 769           </td>\
 770         </tr>\
 771         {{#if md-date}}\
 772         <tr>\
 773           <th>Date</th>\
 774           <td>{{md-date}}</td>\
 775         </tr>\
 776         {{/if}}\
 777         {{#if md-author}}\
 778         <tr>\
 779           <th>Author</th>\
 780           <td>{{md-author}}</td>\
 781         </tr>\
 782         {{/if}}\
 783         {{#if md-electronic-url}}\
 784         <tr>\
 785           <th>URL</th>\
 786           <td>\
 787             {{#each md-electronic-url}}\
 788               <a href="{{this}}">{{this}}</a><br/>\
 789             {{/each}}\
 790           </td>\
 791         </tr>\
 792         {{/if}}\
 793         {{#if-any location having="md-subject"}}\
 794         <tr>\
 795           <th>Subject</th>\
 796           <td>\
 797             {{#first location having="md-subject"}}\
 798               {{#if md-subject}}\
 799                 {{md-subject}}\
 800               {{/if}}\
 801             {{/first}}\
 802           </td>\
 803         </tr>\
 804         {{/if-any}}\
 805         <tr>\
 806           <th>Locations</th>\
 807           <td>\
 808             {{#commaList location}}\
 809               {{attr "@name"}}{{/commaList}}\
 810           </td>\
 811         </tr>\
 812       </table>\
 813 ';
 814     } else if (name === "Summary") {
 815         return '\
 816       <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
 817         <b>{{md-title}}</b>\
 818       </a>\
 819       {{#if md-title-remainder}}\
 820         <span>{{md-title-remainder}}</span>\
 821       {{/if}}\
 822       {{#if md-title-responsibility}}\
 823         <span><i>{{md-title-responsibility}}</i></span>\
 824       {{/if}}\
 825 ';
 826     }
 827
 828     var s = "There is no default '" + name +"' template!";
 829     alert(s);
 830     return s;
 831 }
 832
 833
 834 /*
 835  * All the HTML stuff to render the search forms and
 836  * result pages.
 837  */
 838 function mkws_html_all() {
 839     mkws_set_lang();
 840     if (mkws_config.show_lang)
 841         mkws_html_lang();
 842
 843     // For some reason, doing this programmatically results in
 844     // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
 845     debug("HTML search form");
 846     $("#mkwsSearch").html('\
 847     <form name="mkwsSearchForm" action="" >\
 848       <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
 849       <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
 850     </form>');
 851
 852     debug("HTML records");
 853     // If the application has an #mkwsResults, populate it in the
 854     // usual way. If not, assume that it's a smarter application that
 855     // defines its own subcomponents:
 856     //  #mkwsTermlists
 857     //  #mkwsRanking
 858     //  #mkwsPager
 859     //  #mkwsNavi
 860     //  #mkwsRecords
 861     if ($("#mkwsResults").length) {
 862         $("#mkwsResults").html('\
 863       <table width="100%" border="0" cellpadding="6" cellspacing="0">\
 864         <tr>\
 865           <td id="mkwsTermlistContainer1" width="250" valign="top">\
 866             <div id="mkwsTermlists"></div>\
 867           </td>\
 868           <td id="mkwsMOTDContainer" valign="top">\
 869             <div id="mkwsRanking"></div>\
 870             <div id="mkwsPager"></div>\
 871             <div id="mkwsNavi"></div>\
 872             <div id="mkwsRecords"></div>\
 873           </td>\
 874         </tr>\
 875         <tr>\
 876           <td colspan="2">\
 877             <div id="mkwsTermlistContainer2"></div>\
 878           </td>\
 879         </tr>\
 880       </table>');
 881     }
 882
 883     if ($("#mkwsRanking").length) {
 884         var ranking_data = '';
 885         ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
 886         if (mkws_config.show_sort) {
 887             ranking_data +=  M('Sort by') + ' ' + mkws_html_sort() + ' ';
 888         }
 889         if (mkws_config.show_perpage) {
 890             ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
 891         }
 892         ranking_data += '</form>';
 893
 894         $("#mkwsRanking").html(ranking_data);
 895     }
 896
 897     mkws_html_switch();
 898
 899     if (mkws_config.use_service_proxy)
 900           mkws_service_proxy_auth(mkws_config.service_proxy_auth,
 901           mkws_config.service_proxy_auth_domain);
 902
 903     if (mkws_config.responsive_design_width) {
 904         // Responsive web design - change layout on the fly based on
 905         // current screen width. Required for mobile devices.
 906         $(window).resize( function(e) { mkws_resize_page() });
 907         // initial check after page load
 908         $(document).ready(function() { mkws_resize_page() });
 909     }
 910
 911     domReady();
 912
 913     // on first page, hide the termlist
 914     $(document).ready(function() { $("#mkwsTermlists").hide(); } );
 915     var motd = document.getElementById("mkwsMOTD");
 916     var container = document.getElementById("mkwsMOTDContainer");
 917     if (motd && container) {
 918         // Move the MOTD from the provided element down into the container
 919         motd.parentNode.removeChild(motd);
 920         container.appendChild(motd);
 921     }
 922 }
 923
 924
 925 function run_auto_searches() {
 926     var node = $('#mkwsRecords');
 927     if (node.attr('autosearch')) {
 928         var query = node.attr('autosearch');
 929         var sort = node.attr('sort');
 930         var targets = node.attr('targets');
 931         var s = "running auto search: '" + query + "'";
 932         if (sort) s += " sorted by '" + sort + "'";
 933         if (targets) s += " in targets '" + targets + "'";
 934         debug(s);
 935         newSearch(query, sort, targets);
 936     }
 937 }
 938
 939
 940 function mkws_set_lang()  {
 941     var lang = $.parseQuerystring().lang || mkws_config.lang;
 942     if (!lang || !mkws.locale_lang[lang]) {
 943         mkws_config.lang = ""
 944     } else {
 945         mkws_config.lang = lang;
 946     }
 947
 948     debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
 949     return mkws_config.lang;
 950 }
 951
 952 function mkws_html_switch() {
 953     debug("HTML switch");
 954
 955     $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_records" onclick="mkws.switchView(\'records\')">' + M('Records') + '</a>'));
 956     $("#mkwsSwitch").append($("<span/>", { text: " | " }));
 957     $("#mkwsSwitch").append($('<a href="#" id="mkwsSwitch_targets" onclick="mkws.switchView(\'targets\')">' + M('Targets') + '</a>'));
 958
 959     debug("HTML targets");
 960     $("#mkwsTargets").html('\
 961       <div id="mkwsBytarget">\
 962        No information available yet.\
 963       </div>');
 964     $("#mkwsTargets").css("display", "none");
 965 }
 966
 967 function mkws_html_sort() {
 968     debug("HTML sort, mkws.sort = '" + mkws.sort + "'");
 969     var sort_html = '<select name="mkwsSort" id="mkwsSort">';
 970
 971     for(var i = 0; i < mkws_config.sort_options.length; i++) {
 972         var opt = mkws_config.sort_options[i];
 973         var key = opt[0];
 974         var val = opt.length == 1 ? opt[0] : opt[1];
 975
 976         sort_html += '<option value="' + key + '"';
 977         if (mkws.sort == key || mkws.sort == val) {
 978             sort_html += ' selected="selected"';
 979         }
 980         sort_html += '>' + M(val) + '</option>';
 981     }
 982     sort_html += '</select>';
 983
 984     return sort_html;
 985 }
 986
 987 function mkws_html_perpage() {
 988     debug("HTML perpage");
 989     var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
 990
 991     for(var i = 0; i < mkws_config.perpage_options.length; i++) {
 992         var key = mkws_config.perpage_options[i];
 993
 994         perpage_html += '<option value="' + key + '"';
 995         if (key == mkws_config.perpage_default) {
 996             perpage_html += ' selected="selected"';
 997         }
 998         perpage_html += '>' + key + '</option>';
 999     }
1000     perpage_html += '</select>';
1001
1002     return perpage_html;
1003 }
1004
1005 /*
1006  * Run service-proxy authentication in background (after page load).
1007  * The username/password is configured in the apache config file
1008  * for the site.
1009  */
1010 function mkws_service_proxy_auth(auth_url, auth_domain) {
1011     debug("Run service proxy auth URL: " + auth_url);
1012
1013     var request = new pzHttpRequest(auth_url, function(err) {
1014           alert("HTTP call for authentication failed: " + err)
1015           return;
1016     }, auth_domain);
1017
1018     request.get(null, function(data) {
1019         if (!$.isXMLDoc(data)) {
1020             alert("service proxy auth response document is not valid XML document, give up!");
1021             return;
1022         }
1023         var status = $(data).find("status");
1024         if (status.text() != "OK") {
1025             alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1026             return;
1027         }
1028
1029         debug("Service proxy auth successfully done");
1030         mkws.authenticated = true;
1031         run_auto_searches();
1032     });
1033 }
1034
1035 /* create locale language menu */
1036 function mkws_html_lang() {
1037     var lang_default = "en";
1038     var lang = mkws_config.lang || lang_default;
1039     var list = [];
1040
1041     /* display a list of configured languages, or all */
1042     var lang_options = mkws_config.lang_options || [];
1043     var hash = {};
1044     for (var i = 0; i < lang_options.length; i++) {
1045         hash[lang_options[i]] = 1;
1046     }
1047
1048     for (var k in mkws.locale_lang) {
1049         if (hash[k] == 1 || lang_options.length == 0)
1050             list.push(k);
1051     }
1052
1053     // add english link
1054     if (lang_options.length == 0 || hash[lang_default] == 1)
1055         list.push(lang_default);
1056
1057     debug("Language menu for: " + list.join(", "));
1058
1059     /* the HTML part */
1060     var data = "";
1061     for(var i = 0; i < list.length; i++) {
1062         var l = list[i];
1063
1064         if (data)
1065             data += ' | ';
1066
1067         if (lang == l) {
1068             data += ' <span>' + l + '</span> ';
1069         } else {
1070             data += ' <a href="?lang=' + l + '">' + l + '</a> '
1071         }
1072     }
1073
1074     $("#mkwsLang").html(data);
1075 }
1076
1077 function mkws_resize_page () {
1078     var list = ["mkwsSwitch"];
1079
1080     var width = mkws_config.responsive_design_width;
1081     var parentId = $("#mkwsTermlists").parent().attr('id');
1082
1083     if ($(window).width() <= width &&
1084         parentId === "mkwsTermlistContainer1") {
1085         debug("changing from wide to narrow: " + $(window).width());
1086         $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer2"));
1087         $("#mkwsTermlistContainer1").hide();
1088         $("#mkwsTermlistContainer2").show();
1089         for(var i = 0; i < list.length; i++) {
1090             $("#" + list[i]).hide();
1091         }
1092     } else if ($(window).width() > width &&
1093         parentId === "mkwsTermlistContainer2") {
1094         debug("changing from narrow to wide: " + $(window).width());
1095         $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer1"));
1096         $("#mkwsTermlistContainer1").show();
1097         $("#mkwsTermlistContainer2").hide();
1098         for(var i = 0; i < list.length; i++) {
1099             $("#" + list[i]).show();
1100         }
1101     }
1102 };
1103
1104 /* locale */
1105 function M(word) {
1106     var lang = mkws_config.lang;
1107
1108     if (!lang || !mkws.locale_lang[lang])
1109         return word;
1110
1111     return mkws.locale_lang[lang][word] || word;
1112 }
1113
1114 /*
1115  * implement jQuery plugins
1116  */
1117 $.extend({
1118     // implement $.parseQuerystring() for parsing URL parameters
1119     parseQuerystring: function() {
1120         var nvpair = {};
1121         var qs = window.location.search.replace('?', '');
1122         var pairs = qs.split('&');
1123         $.each(pairs, function(i, v){
1124             var pair = v.split('=');
1125             nvpair[pair[0]] = pair[1];
1126         });
1127         return nvpair;
1128     },
1129
1130     debug2: function(string) { // delayed debug, internal variables are set after dom ready
1131         setTimeout(function() { debug(string); }, 500);
1132     },
1133
1134     // service-proxy or pazpar2
1135     pazpar2: function(config) {
1136         var id_popup = config.id_popup || "#mkwsPopup";
1137         id_popup = id_popup.replace(/^#/, "");
1138
1139         // simple layout
1140         var div = '<div id="mkwsSwitch"></div>\
1141         <div id="mkwsLang"></div>\
1142         <div id="mkwsSearch"></div>\
1143         <div id="mkwsResults"></div>\
1144         <div id="mkwsTargets"></div>\
1145         <div id="mkwsStat"></div>';
1146
1147         // new table layout
1148         var table = '\
1149         <style type="text/css">\
1150           #mkwsTermlists div.facet {\
1151           float:left;\
1152           width: 30%;\
1153           margin: 0.3em;\
1154           }\
1155           #mkwsStat {\
1156           text-align: right;\
1157           }\
1158         </style>\
1159             \
1160         <table width="100%" border="0">\
1161           <tr>\
1162             <td>\
1163               <div id="mkwsSwitch"></div>\
1164               <div id="mkwsLang"></div>\
1165               <div id="mkwsSearch"></div>\
1166             </td>\
1167           </tr>\
1168           <tr>\
1169             <td>\
1170               <div style="height:500px; overflow: auto">\
1171                 <div id="mkwsPager"></div>\
1172                 <div id="mkwsNavi"></div>\
1173                 <div id="mkwsRecords"></div>\
1174                 <div id="mkwsTargets"></div>\
1175                 <div id="mkwsRanking"></div>\
1176               </div>\
1177             </td>\
1178           </tr>\
1179           <tr>\
1180             <td>\
1181               <div style="height:300px; overflow: hidden">\
1182                 <div id="mkwsTermlists"></div>\
1183               </div>\
1184             </td>\
1185           </tr>\
1186           <tr>\
1187             <td>\
1188               <div id="mkwsStat"></div>\
1189             </td>\
1190           </tr>\
1191         </table>';
1192
1193         var popup = '\
1194           <div id="mkwsSearch"></div>\
1195           <div id="' + id_popup + '">\
1196             <div id="mkwsSwitch"></div>\
1197             <div id="mkwsLang"></div>\
1198             <div id="mkwsResults"></div>\
1199             <div id="mkwsTargets"></div>\
1200             <div id="mkwsStat"></div>\
1201           </div>'
1202
1203         if (config && config.layout == 'div') {
1204             this.debug2("jquery plugin layout: div");
1205             document.write(div);
1206         } else if (config && config.layout == 'popup') {
1207             this.debug2("jquery plugin layout: popup with id: " + id_popup);
1208             document.write(popup);
1209             $(document).ready( function() { init_popup(config); } );
1210         } else {
1211             this.debug2("jquery plugin layout: table");
1212             document.write(table);
1213         }
1214     }
1215 });
1216
1217 function init_popup(obj) {
1218     var config = obj ? obj : {};
1219
1220     var height = config.height || 760;
1221     var width = config.width || 880;
1222     var id_button = config.id_button || "input#mkwsButton";
1223     var id_popup = config.id_popup || "#mkwsPopup";
1224
1225     debug("popup height: " + height + ", width: " + width);
1226
1227     // make sure that jquery-ui was loaded afte jQuery core lib, e.g.:
1228     // <script src="http://code.jquery.com/ui/1.10.3/jquery-ui.min.js"></script>
1229     if (!$.ui) {
1230         debug("Error: jquery-ui.js is missing, did you included it after jquery core in the HTML file?");
1231         return;
1232     }
1233
1234     $(id_popup).dialog({
1235       closeOnEscape: true,
1236       autoOpen: false,
1237       height: height,
1238       width: width,
1239       modal: true,
1240       resizable: true,
1241       buttons: {
1242               Cancel: function() {
1243                       $(this).dialog("close");
1244               }
1245       },
1246       close: function() { }
1247     });
1248
1249     $(id_button)
1250       .button()
1251       .click(function() {
1252               $(id_popup).dialog("open");
1253       });
1254 };
1255
1256
1257
1258
1259 /* magic */
1260 $(document).ready(function() {
1261     try {
1262         mkws_html_all()
1263     }
1264
1265     catch (e) {
1266         mkws_config.error = e.message;
1267         // alert(e.message);
1268     }
1269 });
1270
1271 })(jQuery);