tools/htdocs/mkws.js

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