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