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         for (var i = 0; i < m_filters.length; i++) {
 352             if (m_filters[i].id === id ||
 353                 m_filters[i].id === 'pz:id=' + id) {
 354                 return true;
 355             }
 356         }
 357         return false;
 358     }
 359
 360
 361     function my_onrecord(data, args, teamName) {
 362         debug("record: teamName=" + teamName + ", m_teamName=" + m_teamName);
 363         // FIXME: record is async!!
 364         clearTimeout(m_paz.recordTimer);
 365         // in case on_show was faster to redraw element
 366         var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
 367         if (detRecordDiv) return;
 368         m_curDetRecData = data;
 369         var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_curDetRecData.recid);
 370         var html = renderDetails(m_curDetRecData);
 371         recordDiv.innerHTML += html;
 372     }
 373
 374
 375     function my_onbytarget(data, teamName) {
 376         debug("target");
 377         var targetDiv = $('.mkwsBytarget.mkwsTeam_' + teamName);
 378         if (!targetDiv) {
 379             return;
 380         }
 381
 382         var table ='<table><thead><tr>' +
 383             '<td>' + M('Target ID') + '</td>' +
 384             '<td>' + M('Hits') + '</td>' +
 385             '<td>' + M('Diags') + '</td>' +
 386             '<td>' + M('Records') + '</td>' +
 387             '<td>' + M('State') + '</td>' +
 388             '</tr></thead><tbody>';
 389
 390         for (var i = 0; i < data.length; i++) {
 391             table += "<tr><td>" + data[i].id +
 392                 "</td><td>" + data[i].hits +
 393                 "</td><td>" + data[i].diagnostic +
 394                 "</td><td>" + data[i].records +
 395                 "</td><td>" + data[i].state + "</td></tr>";
 396         }
 397
 398         table += '</tbody></table>';
 399         targetDiv.html(table);
 400     }
 401
 402     ////////////////////////////////////////////////////////////////////////////////
 403     ////////////////////////////////////////////////////////////////////////////////
 404
 405
 406     // when search button pressed
 407     function onFormSubmitEventHandler()
 408     {
 409         mkws.handle_node_with_team(this, function (tname) {
 410             var val = $('.mkwsQuery.mkwsTeam_' + tname).val();
 411             mkws.teams[tname].newSearch(val);
 412         });
 413
 414         return false;
 415     }
 416
 417
 418     that.newSearch = function(query, sort, targets, windowid)
 419     {
 420         debug("newSearch: " + query);
 421
 422         if (mkws_config.use_service_proxy && !mkws.authenticated) {
 423             alert("searching before authentication");
 424             return;
 425         }
 426
 427         m_filters = []
 428         redraw_navi();
 429         resetPage();
 430         loadSelect();
 431         triggerSearch(query, sort, targets, windowid);
 432         that.switchView('records'); // In case it's configured to start off as hidden
 433         m_submitted = true;
 434     }
 435
 436
 437     function onSelectDdChange()
 438     {
 439         if (!m_submitted) return false;
 440         resetPage();
 441         loadSelect();
 442         m_paz.show(0, m_perpage, m_sort);
 443         return false;
 444     }
 445
 446
 447     function resetPage()
 448     {
 449         m_curPage = 1;
 450         m_totalRec = 0;
 451     }
 452
 453
 454     function triggerSearch (query, sort, targets, windowid)
 455     {
 456         var pp2filter = "";
 457         var pp2limit = "";
 458
 459         // Re-use previous query/sort if new ones are not specified
 460         if (query) {
 461             m_query = query;
 462         }
 463         if (sort) {
 464             m_sort = sort;
 465         }
 466         if (targets) {
 467             // ### should support multiple |-separated targets
 468             m_filters.push({ id: targets, name: targets });
 469         }
 470
 471         for (var i in m_filters) {
 472             var filter = m_filters[i];
 473             if (filter.id) {
 474                 if (pp2filter)
 475                     pp2filter += ",";
 476                 if (filter.id.match(/^[a-z:]+[=~]/)) {
 477                     debug("filter '" + filter.id + "' already begins with SETTING OP");
 478                 } else {
 479                     filter.id = 'pz:id=' + filter.id;
 480                 }
 481                 pp2filter += filter.id;
 482             } else {
 483                 if (pp2limit)
 484                     pp2limit += ",";
 485                 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
 486             }
 487         }
 488
 489         var params = {};
 490         if (pp2limit) {
 491             params.limit = pp2limit;
 492         }
 493         if (windowid) {
 494             params.windowid = windowid;
 495         }
 496         debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
 497
 498         m_paz.search(m_query, m_perpage, m_sort, pp2filter, undefined, params);
 499     }
 500
 501
 502     function loadSelect ()
 503     {
 504         var node = $('.mkwsSort.mkwsTeam_' + m_teamName);
 505         if (node.length && node.val() != m_sort) {
 506             debug("changing m_sort from " + m_sort + " to " + node.val());
 507             m_sort = node.val();
 508         }
 509         node = $('.mkwsPerpage.mkwsTeam_' + m_teamName);
 510         if (node.length && node.val() != m_perpage) {
 511             debug("changing m_perpage from " + m_perpage + " to " + node.val());
 512             m_perpage = node.val();
 513         }
 514     }
 515
 516
 517     // limit by target functions
 518     that.limitTarget  = function (id, name)
 519     {
 520         debug("limitTarget(id=" + id + ", name=" + name + ")");
 521         m_filters.push({ id: id, name: name });
 522         redraw_navi();
 523         resetPage();
 524         loadSelect();
 525         triggerSearch();
 526         return false;
 527     }
 528
 529
 530     // limit the query after clicking the facet
 531     that.limitQuery = function (field, value)
 532     {
 533         debug("limitQuery(field=" + field + ", value=" + value + ")");
 534         m_filters.push({ field: field, value: value });
 535         redraw_navi();
 536         resetPage();
 537         loadSelect();
 538         triggerSearch();
 539         return false;
 540     }
 541
 542
 543     that.delimitTarget = function (id)
 544     {
 545         debug("delimitTarget(id=" + id + ")");
 546         var newFilters = [];
 547         for (var i in m_filters) {
 548             var filter = m_filters[i];
 549             if (filter.id) {
 550                 debug("delimitTarget() removing filter " + $.toJSON(filter));
 551             } else {
 552                 debug("delimitTarget() keeping filter " + $.toJSON(filter));
 553                 newFilters.push(filter);
 554             }
 555         }
 556         m_filters = newFilters;
 557
 558         redraw_navi();
 559         resetPage();
 560         loadSelect();
 561         triggerSearch();
 562         return false;
 563     }
 564
 565
 566     that.delimitQuery = function (field, value)
 567     {
 568         debug("delimitQuery(field=" + field + ", value=" + value + ")");
 569         var newFilters = [];
 570         for (var i in m_filters) {
 571             var filter = m_filters[i];
 572             if (filter.field &&
 573                 field == filter.field &&
 574                 value == filter.value) {
 575                 debug("delimitQuery() removing filter " + $.toJSON(filter));
 576             } else {
 577                 debug("delimitQuery() keeping filter " + $.toJSON(filter));
 578                 newFilters.push(filter);
 579             }
 580         }
 581         m_filters = newFilters;
 582
 583         redraw_navi();
 584         resetPage();
 585         loadSelect();
 586         triggerSearch();
 587         return false;
 588     }
 589
 590
 591     function redraw_navi ()
 592     {
 593         var navi = $('.mkwsNavi.mkwsTeam_' + m_teamName);
 594         if (!navi) return;
 595
 596         var text = "";
 597         for (var i in m_filters) {
 598             if (text) {
 599                 text += " | ";
 600             }
 601             var filter = m_filters[i];
 602             if (filter.id) {
 603                 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
 604                     "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
 605             } else {
 606                 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
 607                     "', '" + filter.field + "', '" + filter.value + "'" +
 608                     ');return false;">' + filter.value + '</a>';
 609             }
 610         }
 611
 612         navi.html(text);
 613     }
 614
 615
 616     function drawPager (data)
 617     {
 618         var s = '<div style="float: right">' + M('Displaying') + ': '
 619             + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
 620             ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
 621             + data.total + ')</div>';
 622
 623         //client indexes pages from 1 but pz2 from 0
 624         var onsides = 6;
 625         var pages = Math.ceil(m_totalRec / m_perpage);
 626
 627         var firstClkbl = (m_curPage - onsides > 0)
 628             ? m_curPage - onsides
 629             : 1;
 630
 631         var lastClkbl = firstClkbl + 2*onsides < pages
 632             ? firstClkbl + 2*onsides
 633             : pages;
 634
 635         var prev = '<span class="mkwsPrev">&#60;&#60; ' + M('Prev') + '</span><b> | </b>';
 636         if (m_curPage > 1)
 637             prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
 638             +'&#60;&#60; ' + M('Prev') + '</a><b> | </b>';
 639
 640         var middle = '';
 641         for(var i = firstClkbl; i <= lastClkbl; i++) {
 642             var numLabel = i;
 643             if(i == m_curPage)
 644                 numLabel = '<b>' + i + '</b>';
 645
 646             middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
 647                 + numLabel + ' </a>';
 648         }
 649
 650         var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' &#62;&#62;</span>';
 651         if (pages - m_curPage > 0)
 652             next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
 653             + M('Next') + ' &#62;&#62;</a>';
 654
 655         var predots = '';
 656         if (firstClkbl > 1)
 657             predots = '...';
 658
 659         var postdots = '';
 660         if (lastClkbl < pages)
 661             postdots = '...';
 662
 663         s += '<div style="float: clear">'
 664             + prev + predots + middle + postdots + next + '</div>';
 665
 666         return s;
 667     }
 668
 669
 670     that.showPage = function (pageNum)
 671     {
 672         m_curPage = pageNum;
 673         m_paz.showPage(m_curPage - 1);
 674     }
 675
 676
 677     // simple paging functions
 678     that.pagerNext = function () {
 679         if (m_totalRec - m_perpage*m_curPage > 0) {
 680             m_paz.showNext();
 681             m_curPage++;
 682         }
 683     }
 684
 685
 686     that.pagerPrev = function () {
 687         if (m_paz.showPrev() != false)
 688             m_curPage--;
 689     }
 690
 691
 692     // switching view between targets and records
 693     that.switchView = function(view) {
 694         var targets = $('.mkwsTargets.mkwsTeam_' + m_teamName);
 695         var results = $('.mkwsResults.mkwsTeam_' + m_teamName + ',.mkwsRecords.mkwsTeam_' + m_teamName);
 696         var blanket = $('.mkwsBlanket.mkwsTeam_' + m_teamName);
 697         var motd    = $('.mkwsMOTD.mkwsTeam_' + m_teamName);
 698
 699         switch(view) {
 700         case 'targets':
 701             if (targets) targets.css('display', 'block');
 702             if (results) results.css('display', 'none');
 703             if (blanket) blanket.css('display', 'none');
 704             if (motd) motd.css('display', 'none');
 705             break;
 706         case 'records':
 707             if (targets) targets.css('display', 'none');
 708             if (results) results.css('display', 'block');
 709             if (blanket) blanket.css('display', 'block');
 710             if (motd) motd.css('display', 'none');
 711             break;
 712         case 'none':
 713             alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
 714             if (targets) targets.css('display', 'none');
 715             if (results) results.css('display', 'none');
 716             if (blanket) blanket.css('display', 'none');
 717             if (motd) motd.css('display', 'none');
 718             break;
 719         default:
 720             alert("Unknown view '" + view + "'");
 721         }
 722     }
 723
 724
 725     // detailed record drawing
 726     that.showDetails = function (prefixRecId) {
 727         var recId = prefixRecId.replace('mkwsRec_', '');
 728         var oldRecId = m_curDetRecId;
 729         m_curDetRecId = recId;
 730
 731         // remove current detailed view if any
 732         var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecId);
 733         // lovin DOM!
 734         if (detRecordDiv)
 735             detRecordDiv.parentNode.removeChild(detRecordDiv);
 736
 737         // if the same clicked, just hide
 738         if (recId == oldRecId) {
 739             m_curDetRecId = '';
 740             m_curDetRecData = null;
 741             return;
 742         }
 743         // request the record
 744         debug("showDetails() requesting record '" + recId + "'");
 745         m_paz.record(recId);
 746     }
 747
 748
 749     function renderDetails(data, marker)
 750     {
 751         var template = loadTemplate("Record");
 752         var details = template(data);
 753         return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
 754     }
 755
 756
 757     function loadTemplate(name)
 758     {
 759         var template = mkws['template' + name];
 760
 761         if (template === undefined) {
 762             var source = $("#mkwsTemplate" + name).html();
 763             if (!source) {
 764                 source = defaultTemplate(name);
 765             }
 766
 767             template = Handlebars.compile(source);
 768             debug("compiled template '" + name + "'");
 769             mkws['template' + name] = template;
 770         }
 771
 772         return template;
 773     }
 774
 775
 776     function defaultTemplate(name)
 777     {
 778         if (name === 'Record') {
 779             return '\
 780 <table>\
 781   <tr>\
 782     <th>{{translate "Title"}}</th>\
 783     <td>\
 784       {{md-title}}\
 785       {{#if md-title-remainder}}\
 786         ({{md-title-remainder}})\
 787       {{/if}}\
 788       {{#if md-title-responsibility}}\
 789         <i>{{md-title-responsibility}}</i>\
 790       {{/if}}\
 791     </td>\
 792   </tr>\
 793   {{#if md-date}}\
 794   <tr>\
 795     <th>{{translate "Date"}}</th>\
 796     <td>{{md-date}}</td>\
 797   </tr>\
 798   {{/if}}\
 799   {{#if md-author}}\
 800   <tr>\
 801     <th>{{translate "Author"}}</th>\
 802     <td>{{md-author}}</td>\
 803   </tr>\
 804   {{/if}}\
 805   {{#if md-electronic-url}}\
 806   <tr>\
 807     <th>{{translate "URL"}}</th>\
 808     <td>\
 809       {{#each md-electronic-url}}\
 810         <a href="{{this}}">{{this}}</a><br/>\
 811       {{/each}}\
 812     </td>\
 813   </tr>\
 814   {{/if}}\
 815   {{#if-any location having="md-subject"}}\
 816   <tr>\
 817     <th>{{translate "Subject"}}</th>\
 818     <td>\
 819       {{#first location having="md-subject"}}\
 820         {{#if md-subject}}\
 821           {{md-subject}}\
 822         {{/if}}\
 823       {{/first}}\
 824     </td>\
 825   </tr>\
 826   {{/if-any}}\
 827   <tr>\
 828     <th>{{translate "Locations"}}</th>\
 829     <td>\
 830       {{#commaList location}}\
 831         {{attr "@name"}}{{/commaList}}\
 832     </td>\
 833   </tr>\
 834 </table>\
 835 ';
 836         } else if (name === "Summary") {
 837             return '\
 838 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
 839   <b>{{md-title}}</b>\
 840 </a>\
 841 {{#if md-title-remainder}}\
 842   <span>{{md-title-remainder}}</span>\
 843 {{/if}}\
 844 {{#if md-title-responsibility}}\
 845   <span><i>{{md-title-responsibility}}</i></span>\
 846 {{/if}}\
 847 ';
 848         }
 849
 850         var s = "There is no default '" + name +"' template!";
 851         alert(s);
 852         return s;
 853     }
 854
 855
 856     /*
 857      * All the HTML stuff to render the search forms and
 858      * result pages.
 859      */
 860     function mkws_html_all() {
 861         mkws_set_lang();
 862         if (mkws_config.show_lang)
 863             mkws_html_lang();
 864
 865         debug("HTML search form");
 866         // ### There is only one match here by design: fix not to bother looping
 867         $('.mkwsSearch.mkwsTeam_' + m_teamName).each(function (i, obj) {
 868             var node = this;
 869             mkws.handle_node_with_team(node, function(tname) {
 870                 $(node).html('\
 871 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
 872   <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
 873   <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
 874 </form>');
 875             });
 876         });
 877
 878         debug("HTML records");
 879         // If the team has a .mkwsResults, populate it in the usual
 880         // way. If not, assume that it's a smarter application that
 881         // defines its own subcomponents, some or all of the
 882         // following:
 883         //      .mkwsTermlists
 884         //      .mkwsRanking
 885         //      .mkwsPager
 886         //      .mkwsNavi
 887         //      .mkwsRecords
 888         if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) {
 889             $(".mkwsResults.mkwsTeam_" + m_teamName).html('\
 890 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
 891   <tr>\
 892     <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
 893       <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
 894     </td>\
 895     <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
 896       <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
 897       <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
 898       <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
 899       <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
 900     </td>\
 901   </tr>\
 902   <tr>\
 903     <td colspan="2">\
 904       <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
 905     </td>\
 906   </tr>\
 907 </table>');
 908         }
 909
 910         var node = $(".mkwsRanking.mkwsTeam_" + m_teamName);
 911         if (node.length) {
 912             var ranking_data = '';
 913             ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
 914             if (mkws_config.show_sort) {
 915                 ranking_data +=  M('Sort by') + ' ' + mkws_html_sort() + ' ';
 916             }
 917             if (mkws_config.show_perpage) {
 918                 ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
 919             }
 920             ranking_data += '</form>';
 921
 922             node.html(ranking_data);
 923         }
 924
 925         mkws_html_switch();
 926
 927         // ### Should not be in the team code, since window size is global
 928         if (mkws_config.responsive_design_width) {
 929             // Responsive web design - change layout on the fly based on
 930             // current screen width. Required for mobile devices.
 931             $(window).resize(function(e) { mkws.resize_page() });
 932             // initial check after page load
 933             $(document).ready(function() { mkws.resize_page() });
 934         }
 935
 936         $('.mkwsSearchForm.mkwsTeam_' + m_teamName).each(function (i, obj) {
 937             debug("adding search-forms for team '" + m_teamName + "'");
 938             var node = this;
 939             mkws.handle_node_with_team(node, function(tname) {
 940                 debug("adding search-form '" + tname + "' for team '" + m_teamName + "'");
 941                 $(node).submit(onFormSubmitEventHandler);
 942             });
 943         });
 944
 945         node = $('.mkwsSort.mkwsTeam_' + m_teamName);
 946         if (node.length)
 947             node.change(onSelectDdChange);
 948         node = $('.mkwsPerpage.mkwsTeam_' + m_teamName);
 949         if (node.length)
 950             node.change(onSelectDdChange);
 951
 952         // on first page, hide the termlist
 953         $(document).ready(function() { $(".mkwsTermlists.mkwsTeam_" + m_teamName).hide(); });
 954         var motd = $(".mkwsMOTD.mkwsTeam_" + m_teamName);
 955         var container = $(".mkwsMOTDContainer.mkwsTeam_" + m_teamName);
 956         if (motd.length && container.length) {
 957             // Move the MOTD from the provided element down into the container
 958             motd.appendTo(container);
 959         }
 960     }
 961
 962
 963     // implement $.parseQuerystring() for parsing URL parameters
 964     function parseQuerystring() {
 965         var nvpair = {};
 966         var qs = window.location.search.replace('?', '');
 967         var pairs = qs.split('&');
 968         $.each(pairs, function(i, v){
 969             var pair = v.split('=');
 970             nvpair[pair[0]] = pair[1];
 971         });
 972         return nvpair;
 973     }
 974
 975
 976     function mkws_set_lang()  {
 977         var lang = parseQuerystring().lang || mkws_config.lang;
 978         if (!lang || !mkws.locale_lang[lang]) {
 979             mkws_config.lang = ""
 980         } else {
 981             mkws_config.lang = lang;
 982         }
 983
 984         debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
 985         return mkws_config.lang;
 986     }
 987
 988
 989     function mkws_html_switch() {
 990         debug("HTML switch for team " + m_teamName);
 991
 992         var node = $(".mkwsSwitch.mkwsTeam_" + m_teamName);
 993         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
 994         node.append($("<span/>", { text: " | " }));
 995         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
 996
 997         debug("HTML targets");
 998         var node = $(".mkwsTargets.mkwsTeam_" + m_teamName);
 999         node.html('\
1000 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
1001   No information available yet.\
1002 </div>');
1003         node.css("display", "none");
1004     }
1005
1006
1007     function mkws_html_sort() {
1008         debug("HTML sort, m_sort = '" + m_sort + "'");
1009         var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
1010
1011         for(var i = 0; i < mkws_config.sort_options.length; i++) {
1012             var opt = mkws_config.sort_options[i];
1013             var key = opt[0];
1014             var val = opt.length == 1 ? opt[0] : opt[1];
1015
1016             sort_html += '<option value="' + key + '"';
1017             if (m_sort == key || m_sort == val) {
1018                 sort_html += ' selected="selected"';
1019             }
1020             sort_html += '>' + M(val) + '</option>';
1021         }
1022         sort_html += '</select>';
1023
1024         return sort_html;
1025     }
1026
1027
1028     function mkws_html_perpage() {
1029         debug("HTML perpage, m_perpage = " + m_perpage);
1030         var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
1031
1032         for(var i = 0; i < mkws_config.perpage_options.length; i++) {
1033             var key = mkws_config.perpage_options[i];
1034
1035             perpage_html += '<option value="' + key + '"';
1036             if (key == m_perpage) {
1037                 perpage_html += ' selected="selected"';
1038             }
1039             perpage_html += '>' + key + '</option>';
1040         }
1041         perpage_html += '</select>';
1042
1043         return perpage_html;
1044     }
1045
1046
1047     /* create locale language menu */
1048     function mkws_html_lang() {
1049         var lang_default = "en";
1050         var lang = mkws_config.lang || lang_default;
1051         var list = [];
1052
1053         /* display a list of configured languages, or all */
1054         var lang_options = mkws_config.lang_options || [];
1055         var toBeIncluded = {};
1056         for (var i = 0; i < lang_options.length; i++) {
1057             toBeIncluded[lang_options[i]] = true;
1058         }
1059
1060         for (var k in mkws.locale_lang) {
1061             if (toBeIncluded[k] || lang_options.length == 0)
1062                 list.push(k);
1063         }
1064
1065         // add english link
1066         if (lang_options.length == 0 || toBeIncluded[lang_default])
1067             list.push(lang_default);
1068
1069         debug("Language menu for: " + list.join(", "));
1070
1071         /* the HTML part */
1072         var data = "";
1073         for(var i = 0; i < list.length; i++) {
1074             var l = list[i];
1075
1076             if (data)
1077                 data += ' | ';
1078
1079             if (lang == l) {
1080                 data += ' <span>' + l + '</span> ';
1081             } else {
1082                 data += ' <a href="?lang=' + l + '">' + l + '</a> '
1083             }
1084         }
1085
1086         $(".mkwsLang.mkwsTeam_" + m_teamName).html(data);
1087     }
1088
1089
1090     /* locale */
1091     function M(word) {
1092         var lang = mkws_config.lang;
1093
1094         if (!lang || !mkws.locale_lang[lang])
1095             return word;
1096
1097         return mkws.locale_lang[lang][word] || word;
1098     }
1099     mkws.M = M; // so the Handlebars helper can use it
1100
1101
1102     // main
1103     (function() {
1104         try {
1105             mkws_html_all()
1106         }
1107
1108         catch (e) {
1109             mkws_config.error = e.message;
1110             // alert(e.message);
1111         }
1112     })();
1113
1114     // Bizarrely, 'that' is just an empty hash. All its state is in
1115     // the closure variables defined earlier in this function.
1116     return that;
1117 };
1118
1119
1120 // wrapper to call team() after page load
1121 (function (j) {
1122     mkws.debug = function (string) {
1123         if (!mkws.debug_level)
1124             return;
1125
1126         if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1127             return;
1128         }
1129
1130         // you need to disable use strict at the top of the file!!!
1131         if (mkws.debug_level >= 3) {
1132             console.log(arguments.callee.caller);
1133         } else if (mkws.debug_level >= 2) {
1134             console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1135         }
1136         console.log(string);
1137     }
1138     var debug = mkws.debug;
1139
1140
1141     mkws.handle_node_with_team = function(node, callback) {
1142         var classes = node.className;
1143         var list = classes.split(/\s+/)
1144         var tname;
1145         for (var i = 0; i < list.length; i++) {
1146             var cname = list[i];
1147             if (cname.match(/^mkwsTeam_/)) {
1148                 tname = cname.replace(/^mkwsTeam_/, '');
1149             }
1150         }
1151         callback(tname);
1152     }
1153
1154
1155     mkws.resize_page = function () {
1156         var list = ["mkwsSwitch", "mkwsLang"];
1157
1158         var width = mkws_config.responsive_design_width;
1159         var parent = $(".mkwsTermlists").parent();
1160
1161         if ($(window).width() <= width &&
1162             parent.hasClass("mkwsTermlistContainer1")) {
1163             debug("changing from wide to narrow: " + $(window).width());
1164             $(".mkwsTermlistContainer1").hide();
1165             $(".mkwsTermlistContainer2").show();
1166             for (var tname in mkws.teams) {
1167                 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1168                 for(var i = 0; i < list.length; i++) {
1169                     $("." + list[i] + ".mkwsTeam_" + tname).hide();
1170                 }
1171             }
1172         } else if ($(window).width() > width &&
1173                    parent.hasClass("mkwsTermlistContainer2")) {
1174             debug("changing from narrow to wide: " + $(window).width());
1175             $(".mkwsTermlistContainer1").show();
1176             $(".mkwsTermlistContainer2").hide();
1177             for (var tname in mkws.teams) {
1178                 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1179                 for(var i = 0; i < list.length; i++) {
1180                     $("." + list[i] + ".mkwsTeam_" + tname).show();
1181                 }
1182             }
1183         }
1184     };
1185
1186
1187     mkws.switchView = function(tname, view) {
1188         mkws.teams[tname].switchView(view);
1189     }
1190
1191     mkws.showDetails = function (tname, prefixRecId) {
1192         mkws.teams[tname].showDetails(prefixRecId);
1193     }
1194
1195     mkws.limitTarget  = function (tname, id, name) {
1196         mkws.teams[tname].limitTarget(id, name);
1197     }
1198
1199     mkws.limitQuery  = function (tname, field, value) {
1200         mkws.teams[tname].limitQuery(field, value);
1201     }
1202
1203     mkws.delimitTarget = function (tname, id) {
1204         mkws.teams[tname].delimitTarget(id);
1205     }
1206
1207     mkws.delimitQuery = function (tname, field, value) {
1208         mkws.teams[tname].delimitQuery(field, value);
1209     }
1210
1211     mkws.showPage = function (tname, pageNum) {
1212         mkws.teams[tname].showPage(pageNum);
1213     }
1214
1215     mkws.pagerPrev = function (tname) {
1216         mkws.teams[tname].pagerPrev();
1217     }
1218
1219     mkws.pagerNext = function (tname) {
1220         mkws.teams[tname].pagerNext();
1221     }
1222
1223
1224     function default_mkws_config() {
1225         /* default mkws config */
1226         var config_default = {
1227             use_service_proxy: true,
1228             pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1229             service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1230             lang: "",
1231             sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1232             perpage_options: [10, 20, 30, 50],
1233             sort_default: "relevance",
1234             perpage_default: 20,
1235             query_width: 50,
1236             show_lang: true,    /* show/hide language menu */
1237             show_sort: true,    /* show/hide sort menu */
1238             show_perpage: true,         /* show/hide perpage menu */
1239             lang_options: [],   /* display languages links for given languages, [] for all */
1240             facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1241             responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1242             debug_level: 1,     /* debug level for development: 0..2 */
1243
1244             dummy: "dummy"
1245         };
1246
1247         /* Set global debug_level flag early so that debug() works */
1248         if (typeof mkws_config.debug_level !== 'undefined') {
1249             mkws.debug_level = mkws_config.debug_level;
1250         } else if (typeof config_default.debug_level !== 'undefined') {
1251             mkws.debug_level = config_default.debug_level;
1252         }
1253
1254         // make sure the mkws_config is a valid hash
1255         if (!$.isPlainObject(mkws_config)) {
1256             debug("ERROR: mkws_config is not an JS object, ignore it....");
1257             mkws_config = {};
1258         }
1259
1260         /* override standard config values by function parameters */
1261         for (var k in config_default) {
1262             if (typeof mkws_config[k] === 'undefined')
1263                 mkws_config[k] = config_default[k];
1264             //debug("Set config: " + k + ' => ' + mkws_config[k]);
1265         }
1266     }
1267
1268
1269     /*
1270      * Run service-proxy authentication in background (after page load).
1271      * The username/password is configured in the apache config file
1272      * for the site.
1273      */
1274     function authenticate_session(auth_url, auth_domain, pp2_url) {
1275         debug("Run service proxy auth URL: " + auth_url);
1276
1277         if (!auth_domain) {
1278             auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1279             debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1280         }
1281
1282         var request = new pzHttpRequest(auth_url, function(err) {
1283             alert("HTTP call for authentication failed: " + err)
1284             return;
1285         }, auth_domain);
1286
1287         request.get(null, function(data) {
1288             if (!$.isXMLDoc(data)) {
1289                 alert("service proxy auth response document is not valid XML document, give up!");
1290                 return;
1291             }
1292             var status = $(data).find("status");
1293             if (status.text() != "OK") {
1294                 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1295                 return;
1296             }
1297
1298             debug("Service proxy auth successfully done");
1299             mkws.authenticated = true;
1300             run_auto_searches();
1301         });
1302     }
1303
1304
1305     function run_auto_searches() {
1306         debug("running auto searches");
1307
1308         for (var teamName in mkws.teams) {
1309             // ### should check mkwsTermlist as well, for facet-only teams
1310             var node = $('.mkwsRecords.mkwsTeam_' + teamName);
1311             var query = node.attr('autosearch');
1312             debug("teamName '" + teamName + "', node=" + node + ", class='" + node.className + "', query=" + query);
1313
1314             if (query) {
1315                 var sort = node.attr('sort');
1316                 var targets = node.attr('targets');
1317                 var s = "running auto search: '" + query + "'";
1318                 if (teamName) s += " [teamName '" + teamName + "']";
1319                 if (sort) s += " sorted by '" + sort + "'";
1320                 if (targets) s += " in targets '" + targets + "'";
1321                 debug(s);
1322                 var team = mkws.teams[teamName];
1323                 debug($.toJSON(team));
1324                 team.newSearch(query, sort, targets, teamName);
1325             }
1326         }
1327     }
1328
1329
1330     $(document).ready(function() {
1331         debug("on load ready");
1332         default_mkws_config();
1333
1334         // Backwards compatibility: set new magic class names on any
1335         // elements that have the old magic IDs.
1336         var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1337                     "Results", "Records", "Targets", "Ranking",
1338                     "Termlists", "Stat" ];
1339         for (var i = 0; i < ids.length; i++) {
1340             var id = 'mkws' + ids[i];
1341             var node = $('#' + id);
1342             if (node.attr('id')) {
1343                 node.addClass(id);
1344                 debug("added magic class to '" + node.attr('id') + "'");
1345             }
1346         }
1347
1348         // For all MKWS-classed nodes that don't have a team
1349         // specified, set the team to AUTO.
1350         $('[class^="mkws"],[class*=" mkws"]').each(function () {
1351             if (!this.className.match(/mkwsTeam_/)) {
1352                 debug("adding AUTO team to node with class '" + this.className + "'");
1353                 $(this).addClass('mkwsTeam_AUTO');
1354             }
1355         });
1356
1357         // Find all nodes with an class, and determine their team from
1358         // the mkwsTeam_* class. Make all team objects.
1359         $('[class^="mkws"],[class*=" mkws"]').each(function () {
1360             var node = this;
1361             mkws.handle_node_with_team(node, function(tname) {
1362                 if (!mkws.teams[tname]) {
1363                     mkws.teams[tname] = team(j, tname);
1364                     debug("Made MKWS team '" + tname + "'");
1365                 }
1366             });
1367         });
1368
1369         if (mkws_config.use_service_proxy) {
1370             authenticate_session(mkws_config.service_proxy_auth,
1371                                  mkws_config.service_proxy_auth_domain,
1372                                  mkws_config.pazpar2_url);
1373         } else {
1374             // raw pp2
1375             run_auto_searches();
1376         }
1377     });
1378 })(jQuery);