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