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