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