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