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