tools/htdocs/mkws.js

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