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