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