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