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