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