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