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