tools/htdocs/mkws.js

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