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