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