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