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