tools/htdocs/mkws.js

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