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