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