tools/htdocs/mkws.js

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