tools/htdocs/mkws.js

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