tools/htdocs/mkws.js

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