tools/htdocs/mkws.js

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