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