tools/htdocs/mkws.js

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